Trait Wire 

pub trait Wire:
    Clone
    + WasmCompatSend
    + WasmCompatSync
    + 'static {
    type Op: Operation;
    type Payload: WasmCompatSend + 'static;
    type Frame: WasmCompatSend + 'static;
    type Decoder<'id>: Decoder<'id, Self::Op, Self::Frame> + WasmCompatSend;
    type Reassembler: Reassemble<Self::Frame> + Serves<Self::Op>;

    // Required methods
    fn describe(&self) -> Descriptor<'_>;
    fn encode(
        &self,
        request: Request<Self>,
        mode: Mode,
    ) -> Result<Self::Payload, EncodeError>;
    fn decoder<'id>(&self) -> Self::Decoder<'id>;

    // Provided method
    fn reassembler(&self) -> Self::Reassembler { ... }
}

A provider endpoint: plain data that encodes requests and names a decoder for each reply.

No transport, no future, no type parameter. Implementations are plain data (Clone + PartialEq + Debug + Serialize + Deserialize, with credentials held in Secret), so a host can store one in a scene, a component, or a config file. Clone is a supertrait: the driver clones the wire into every call’s 'static stream.

Required Associated Types

type Op: Operation

The operation this wire performs.

type Payload: WasmCompatSend + 'static

What Self::encode produces for the transport to send.

type Frame: WasmCompatSend + 'static

One unit of a reply, as the transport delivers it.

type Decoder<'id>: Decoder<'id, Self::Op, Self::Frame> + WasmCompatSend

The decoder for one of its replies, branded with that reply.

type Reassembler: Reassemble<Self::Frame> + Serves<Self::Op>

What rebuilds a reply’s provider document from its frames when the transport reports no whole document, as for a stream. The driver feeds it every frame and records what it finishes with as raw. A wire whose operation’s decoders record raw themselves names document::Unreassembled; a completion wire cannot, because it does not Serve completions.

Required Methods

fn describe(&self) -> Descriptor<'_>

What the wire says about itself.

fn encode( &self, request: Request<Self>, mode: Mode, ) -> Result<Self::Payload, EncodeError>

The request to send. Pure: it may read self, request and mode, and nothing else. A request that cannot be built is an EncodeError, which always reports as a request failure.

fn decoder<'id>(&self) -> Self::Decoder<'id>

A fresh decoder for one reply.

Provided Methods

fn reassembler(&self) -> Self::Reassembler

A fresh reassembler for one reply. A wire that picks its API per reply builds the matching one.

Dyn Compatibility

This trait is not dyn compatible.

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

Implementors

impl Wire for CachedContents

type Op = ContextCache

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = CachedContentsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::ollama::chat::Chat

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ChatDecoder

type Reassembler = ChatResponse

impl Wire for rig_core::providers::openai::wire::Chat

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ChatDecoder

type Reassembler = ChatCompletion

impl Wire for CohereChat

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = CohereDecoder

type Reassembler = Routed

impl Wire for CopilotWire

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = OpenAiDecoder

type Reassembler = OpenAiReassembler

impl Wire for rig_core::providers::cohere::embeddings::Embeddings

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = EmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::gemini::embedding::Embeddings

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = EmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::ollama::embedding::Embeddings

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = EmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::openai::wire::Embeddings

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = EmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::voyageai::wire::Embeddings

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = EmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for GenerateContent

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = GenerateContentDecoder

type Reassembler = GenerateContentResponse

impl Wire for ImageEmbeddings

type Op = ImageEmbedding

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ImageEmbeddingsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::gemini::image_generation::Images

Available on crate feature image only.

type Op = ImageGeneration

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ImagesDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::openai::wire::Images

Available on crate feature image only.

type Op = ImageGeneration

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ImagesDecoder

type Reassembler = Unreassembled

impl Wire for InteractionResume

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = InteractionsDecoder

type Reassembler = Interaction

impl Wire for Interactions

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = InteractionsDecoder

type Reassembler = Interaction

impl Wire for InteractionsModels

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for Messages

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = MessagesDecoder

type Reassembler = Message

impl Wire for MockScript

Available on crate feature test-utils only.

type Op = Completion

type Payload = CompletionRequest

type Frame = MockFrame

type Decoder<'id> = MockDecoder<'id>

type Reassembler = MockDocument

impl Wire for rig_core::providers::anthropic::modality::Models

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::copilot::model_listing::Models

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::gemini::model_listing::Models

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::ollama::model_listing::Models

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::openai::wire::Models

type Op = ModelListing

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ModelsDecoder

type Reassembler = Unreassembled

impl Wire for NativeChat

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ChatDecoder

type Reassembler = ChatResponse

impl Wire for OpenAiWire

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = OpenAiDecoder

type Reassembler = OpenAiReassembler

impl Wire for rig_core::providers::openai::wire::Rerank

type Op = Rerank

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = RerankDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::voyageai::wire::Rerank

type Op = Rerank

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = RerankDecoder

type Reassembler = Unreassembled

impl Wire for Responses

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = ResponsesDecoder

type Reassembler = Response

impl Wire for Speech

Available on crate feature audio only.

type Op = AudioGeneration

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = SpeechDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::gemini::transcription::Transcriptions

type Op = Transcription

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = TranscriptionsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::openai::wire::Transcriptions

type Op = Transcription

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = TranscriptionsDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::anthropic::modality::Verify

type Op = Verify

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = VerifyDecoder

type Reassembler = Unreassembled

impl Wire for rig_core::providers::openai::wire::Verify

type Op = Verify

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = VerifyDecoder

type Reassembler = Unreassembled

impl Wire for VerifyKey

type Op = Verify

type Payload = Encoded

type Frame = WireFrame

type Decoder<'id> = VerifyKeyDecoder

type Reassembler = Unreassembled

impl<Op: Operation<Emit = Free>> Wire for Local<Op>

type Op = Op

type Payload = <Op as Operation>::Request

type Frame = Step<Op>

type Decoder<'id> = Steps

type Reassembler = Unreassembled