xema

v0.4.0

xema v0.4.0 Xema.Ref View Source

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

Link to this section Summary

Types

t()

Functions

get_pointer(ref)

Returns the pointer of the given reference

new(pointer)

Creates a new reference from the given pointer

to_string(ref)

Returns the binary representation of a reference

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{path: String.t() | nil, pointer: String.t(), remote: boolean(), url: String.t() | nil}

Link to this section Functions

Link to this function get_pointer(ref) View Source 
get_pointer(Xema.Ref.t()) :: String.t()

Returns the pointer of the given reference.

Link to this function new(pointer) View Source 
new(String.t()) :: Xema.Ref.t()

Creates a new reference from the given pointer.

Examples 

iex> Xema.Ref.new("http://foo.com/bar/baz.exon#/definitions/abc")
%Xema.Ref{
  path: "/bar/baz.exon",
  pointer: "/definitions/abc",
  remote: true,
  url: "http://foo.com:80"
}
Link to this function to_string(ref) View Source 
to_string(Xema.Ref.t()) :: String.t()

Returns the binary representation of a reference.

Examples 

iex> "http://foo.com/bar/baz.exon#/definitions/abc"
...> |> Xema.Ref.new()
...> |> Xema.Ref.to_string()
"{:ref, \"http://foo.com/bar/baz.exon#/definitions/abc\"}"
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.