Jido.Memory.ProviderBootstrap (Jido Memory v1.0.0)

Caller-owned bootstrap helpers for providers that need supervised processes.

The bootstrap contract is intentionally light:

providers may export child_specs/1
callers own supervision and startup strategy
core runtime never starts provider infrastructure implicitly

Summary

Types

provider_input()

Functions

bootstrappable?(provider_input)

Returns true when the provider exports child_specs/1.

child_specs(provider_input, opts \\ [])

Returns provider child specs when the provider exports child_specs/1.

describe(provider_input, opts \\ [])

Returns provider bootstrap metadata without starting any processes.

Types

provider_input()

@type provider_input() ::
  Jido.Memory.ProviderRef.t()
  | module()
  | atom()
  | {module() | atom(), keyword()}
  | nil

Functions

bootstrappable?(provider_input)

@spec bootstrappable?(provider_input()) :: boolean()

Returns true when the provider exports child_specs/1.

child_specs(provider_input, opts \\ [])

@spec child_specs(
  provider_input(),
  keyword()
) :: {:ok, [Supervisor.child_spec()]} | {:error, term()}

Returns provider child specs when the provider exports child_specs/1.

describe(provider_input, opts \\ [])

@spec describe(
  provider_input(),
  keyword()
) ::
  {:ok,
   %{
     provider: module(),
     opts: keyword(),
     child_specs: [Supervisor.child_spec()],
     provider_info: Jido.Memory.ProviderInfo.t(),
     ownership: :caller
   }}
  | {:error, term()}

Returns provider bootstrap metadata without starting any processes.