xema

v0.9.2

xema v0.9.2 Xema.Ref View Source

This module contains a struct and functions to represent and handle references.

Link to this section Summary

Types

t()

A reference contains a pointer and an optional uri.

Functions

fetch!(ref, master, root)

Returns the schema and the root for the given ref and xema.

fragment(ref)
key(uri)

Returns the reference key for a Ref or an URI.

new(pointer)

Creates a new reference from the given pointer.

new(pointer, uri)

Creates a new reference from the given pointer and uri.

validate(ref, value, opts)

Validates the given value with the referenced schema.

Link to this section Types

Link to this type

t() View Source 
t() :: %Xema.Ref{pointer: String.t(), uri: URI.t() | nil}

A reference contains a pointer and an optional uri.

Link to this section Functions

Link to this function

fetch!(ref, master, root) View Source 
fetch!(Xema.Ref.t(), struct(), struct() | nil) :: {struct() | atom(), struct()}

Returns the schema and the root for the given ref and xema.

Link to this function

fragment(ref) View Source

Link to this function

key(uri) View Source 
key(ref :: Xema.Ref.t() | URI.t()) :: String.t()

Returns the reference key for a Ref or an URI.

Link to this function

new(pointer) View Source 
new(String.t()) :: Xema.Ref.t()

Creates a new reference from the given pointer.

Link to this function

new(pointer, uri) View Source 
new(String.t(), URI.t() | nil) :: Xema.Ref.t()

Creates a new reference from the given pointer and uri.

Link to this function

validate(ref, value, opts) View Source 
validate(Xema.Ref.t(), any(), keyword()) :: :ok | {:error, map()}

Validates the given value with the referenced schema.