View Source Xema.Ref (xema v0.16.0)

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

t()

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

A reference contains a pointer and an optional uri.

Link to this section Functions

fetch!(ref, master, root)

@spec fetch!(t(), struct(), struct() | nil) :: {struct() | atom(), struct()}

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

fragment(ref)

key(uri)

@spec key(ref :: t() | URI.t()) :: String.t()

Returns the reference key for a Ref or an URI.

new(pointer)

@spec new(String.t()) :: t()

Creates a new reference from the given pointer.

new(pointer, uri)

@spec new(String.t(), URI.t() | nil) :: t()

Creates a new reference from the given pointer and uri.

validate(ref, value, opts)

@spec validate(t(), any(), keyword()) :: :ok | {:error, map()}

Validates the given value with the referenced schema.