StrawHat v0.6.2

View Source StrawHat.Error.ErrorMetadata (StrawHat v0.6.2)

Metadata used on StrawHat.Error.t/0. It is a representation of key value pair into StrawHat.Error.ErrorMetadata.t/0. Most likely used through StrawHat.Error.

Link to this section Summary

Types

t()
  • key: Key of the metadata.
  • value: Value of the metadata.

Functions

new(value_tuple)

Creates a StrawHat.Error.ErrorMetadata.t/0 from a tuple.

new(key, value)

Creates a StrawHat.Error.ErrorMetadata.t/0.

serialize(metadata)

Serializes a Keyword list into a list of StrawHat.Error.ErrorMetadata.t/0.

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %StrawHat.Error.ErrorMetadata{key: String.t(), value: String.t()}
  • key: Key of the metadata.
  • value: Value of the metadata.

Link to this section Functions

Link to this function

new(value_tuple)

View Source

Specs

new({String.t() | atom(), any()}) :: t()

Creates a StrawHat.Error.ErrorMetadata.t/0 from a tuple.

Link to this function

new(key, value)

View Source

Specs

new(atom() | String.t(), any()) :: t()

Creates a StrawHat.Error.ErrorMetadata.t/0.

Link to this function

serialize(metadata)

View Source

Specs

serialize(Keyword.t()) :: [t()]

Serializes a Keyword list into a list of StrawHat.Error.ErrorMetadata.t/0.