View Source JSV.Builder (jsv v0.3.0)

Internal logic to build raw schemas into JSV.Root structs.

Summary

Types

buildable()
raw_schema()
resolvable()
t()

Functions

build(builder, raw_schema)

Builds the given raw schema into a JSV.Root struct.

build_sub(raw_schema, builder)
ensure_resolved(builder, resolvable)

Ensures that the remote resource that the given reference or key points to is fetched in the builder internal cache

fetch_resolved(map, key)

Returns the raw schema identified by the given key. Use ensure_resolved/2 before if the resource may not have been fetched.

new(opts)

Returns a new builder. Builders are not reusable ; a fresh builder must be made for each different root schema.

stage_build(builder, buildable)

Adds a new key to be built later. A key is generatlly derived from a reference.

vocabulary_enabled?(builder, vocab)

Types

buildable()

@type buildable() :: {:resolved, resolvable()} | resolvable()

raw_schema()

@type raw_schema() :: map() | boolean()

resolvable()

@type resolvable() :: JSV.Resolver.resolvable()

t()

@type t() :: %JSV.Builder{
  ns: term(),
  opts: term(),
  parent_ns: term(),
  resolver: term(),
  staged: [term()],
  vocabularies: term()
}

Functions

build(builder, raw_schema)

@spec build(t(), raw_schema()) :: {:ok, JSV.Root.t()} | {:error, term()}

Builds the given raw schema into a JSV.Root struct.

build_sub(raw_schema, builder)

@spec build_sub(raw_schema(), t()) ::
  {:ok, JSV.Validator.validator(), t()} | {:error, term()}

ensure_resolved(builder, resolvable)

@spec ensure_resolved(t(), resolvable()) ::
  {:ok, t()} | {:error, {:resolver_error, term()}}

Ensures that the remote resource that the given reference or key points to is fetched in the builder internal cache

fetch_resolved(map, key)

@spec fetch_resolved(t(), JSV.Key.t()) :: {:ok, raw_schema()} | {:error, term()}

Returns the raw schema identified by the given key. Use ensure_resolved/2 before if the resource may not have been fetched.

new(opts)

@spec new(keyword()) :: t()

Returns a new builder. Builders are not reusable ; a fresh builder must be made for each different root schema.

stage_build(builder, buildable)

@spec stage_build(t(), buildable()) :: t()

Adds a new key to be built later. A key is generatlly derived from a reference.

vocabulary_enabled?(builder, vocab)

@spec vocabulary_enabled?(t(), module()) :: boolean()