Jido.Memory.Scope (Jido Memory v1.0.0)

Provider-neutral memory scope metadata.

Summary

Types

t()

Functions

from_provider(provider, provider_opts \\ [])

Builds a scope from resolved provider metadata.

new(attrs)

Builds and normalizes a scope.

new!(attrs)

Builds and normalizes a scope, raising on error.

provider_name(provider)

Returns a normalized provider display name.

schema()

Returns the scope schema.

Types

t()

@type t() :: %Jido.Memory.Scope{
  metadata: map(),
  namespace: nil | binary(),
  provider: nil | atom(),
  provider_key: nil | atom(),
  provider_name: nil | binary()
}

Functions

from_provider(provider, provider_opts \\ [])

@spec from_provider(
  module() | atom() | nil,
  keyword()
) :: t()

Builds a scope from resolved provider metadata.

new(attrs)

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

Builds and normalizes a scope.

new!(attrs)

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

Builds and normalizes a scope, raising on error.

provider_name(provider)

@spec provider_name(module() | atom() | nil) :: String.t() | nil

Returns a normalized provider display name.

schema()

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

Returns the scope schema.