xema v0.6.2 Xema.Ref View Source

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

Link to this section Summary

Functions

Creates a new reference from the given pointer

Creates a new reference from the given pointer and uri

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}

Link to this section Functions

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() | Xema.Schema.t() | Xema.t(), any(), keyword()) ::
  :ok | {:error, map()}

Validates the given value with the referenced schema.