JSV.Builder (jsv v0.10.1)

View Source

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

Summary

Types

buildable()
path_segment()
resolvable()
t()

Functions

add_schema!(builder, key, schema)

Adds a schema under the given key to the build, so that key or references to this schema or its subschemas become buildable.

build!(builder, source, validators)

Builds the given root schema or reference into the given validators.

build_sub!(raw_schema, add_rev_path, builder)

Builds a subschema. Called from vocabulary modules to build nested schemas such as in properties, if/else, items, etc.

ensure_resolved!(builder, resolvable)

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

fail(builder, reason, action)
fetch_resolved!(builder, 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()

path_segment()

@type path_segment() :: binary() | non_neg_integer() | atom() | {atom(), term()}

resolvable()

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

t()

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

Functions

add_schema!(builder, key, schema)

@spec add_schema!(t(), JSV.Key.t(), JSV.normal_schema()) :: t()

Adds a schema under the given key to the build, so that key or references to this schema or its subschemas become buildable.

build!(builder, source, validators)

@spec build!(t(), JSV.Ref.ns() | JSV.Ref.t(), JSV.Validator.validators()) ::
  {JSV.Validator.validators(), t()}

Builds the given root schema or reference into the given validators.

build_sub!(raw_schema, add_rev_path, builder)

@spec build_sub!(JSV.normal_schema(), [path_segment()], t()) ::
  {JSV.Validator.validator(), t()} | {:error, term()}

Builds a subschema. Called from vocabulary modules to build nested schemas such as in properties, if/else, items, etc.

ensure_resolved!(builder, resolvable)

@spec ensure_resolved!(t(), resolvable()) :: t()

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

fail(builder, reason, action)

@spec fail(t(), term(), term()) :: no_return()

fetch_resolved!(builder, key)

@spec fetch_resolved!(t(), JSV.Key.t()) ::
  JSV.Resolver.Resolved.t() | {:alias_of, JSV.Key.t()}

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()