Trait Family 

pub trait Family:
    Sealed
    + Clone
    + Copy
    + Send
    + Sync
    + 'static {
    type Request: WasmCompatSend + 'static;
    type Answer: WasmCompatSend + 'static;

    const FAMILY: EffectFamily;

    // Required methods
    fn wrap(request: Self::Request) -> Result<EffectKind, ErrorReport>;
    fn unwrap(outcome: Outcome) -> Result<Self::Answer, ErrorReport>;

    // Provided method
    fn mismatch(outcome: &Outcome) -> ErrorReport { ... }
}

Sealed mapping between typed requests and answers and the wire’s EffectKind and Outcome. Hosts extend the protocol through CustomEffect and family::Custom, not new family implementations.

Required Associated Constants

const FAMILY: EffectFamily

The family this marker names.

Required Associated Types

type Request: WasmCompatSend + 'static

What a typed dispatch of this family takes.

type Answer: WasmCompatSend + 'static

What it resolves to.

Required Methods

fn wrap(request: Self::Request) -> Result<EffectKind, ErrorReport>

The wire form of a request, or the report for a request that has none (a CustomEffect whose Serialize fails). The in-tree families always have one; a typed dispatch of a request without one is pre-failed by the bus and never reaches a handler or a log.

fn unwrap(outcome: Outcome) -> Result<Self::Answer, ErrorReport>

The typed answer, or the report for an outcome of another family.

Provided Methods

fn mismatch(outcome: &Outcome) -> ErrorReport

The report Family::unwrap gives for an outcome of another family.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Family for Completion

const FAMILY: EffectFamily = EffectFamily::Completion

type Request = CompletionRequest

type Answer = CompletionResponse

impl Family for Embed

const FAMILY: EffectFamily = EffectFamily::Embed

type Request = EmbedInputs

type Answer = EmbedOutputs

impl Family for Memory

const FAMILY: EffectFamily = EffectFamily::Memory

type Request = MemoryOp

type Answer = MemoryOutcome

impl Family for Rerank

const FAMILY: EffectFamily = EffectFamily::Rerank

type Request = RerankRequest

type Answer = RerankResponse

impl Family for Retrieve

const FAMILY: EffectFamily = EffectFamily::Retrieve

type Request = RetrieveQuery

type Answer = RetrievedDocuments

impl Family for Tool

const FAMILY: EffectFamily = EffectFamily::Tool

type Request = ToolCallRequest

type Answer = ToolResult

impl<E: CustomEffect> Family for Custom<E>

const FAMILY: EffectFamily = EffectFamily::Custom

type Request = E

type Answer = <E as CustomEffect>::Answer