Jidoka.Memory.WriteResult (Jidoka v0.9.0)

Copy Markdown View Source

Result returned after writing memory.

Summary

Functions

Builds a memory write result from keyword or map attributes.

Builds a memory write result and raises if the attributes are invalid.

Returns the Zoi schema for a memory write result.

Types

t()

@type t() :: %Jidoka.Memory.WriteResult{
  entry: term(),
  metadata: map(),
  request: term(),
  status: :ok
}

Functions

new(attrs)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

Builds a memory write result from keyword or map attributes.

new!(attrs)

@spec new!(keyword() | map()) :: t()

Builds a memory write result and raises if the attributes are invalid.

schema()

@spec schema() :: Zoi.schema()

Returns the Zoi schema for a memory write result.