Trait Wire

Source

pub trait Wire:
    Clone
    + WasmCompatSend
    + WasmCompatSync
    + 'static {
    type Op: Operation;
    type Payload: WasmCompatSend + 'static;
    type Frame: WasmCompatSend + 'static;
    type Event: WasmCompatSend + 'static;
    type Decoder<'id>: Decoder<'id, Self::Op, Self::Frame, Event = Self::Event> + WasmCompatSend;
    type Reassembler: Reassemble<Self::Event> + 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 { ... }
}

Expand description

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§

Source

type Op: Operation

The operation this wire performs.

Source

type Payload: WasmCompatSend + 'static

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

Source

type Frame: WasmCompatSend + 'static

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

Source

type Event: WasmCompatSend + 'static

The decoder’s classified event, which the reassembler reads too.

Source

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

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

Source

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

What rebuilds a reply’s provider document from its events when the transport reports no whole document, as for a stream. The driver hands it every known event before the decoder decodes it, 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§

Source

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

What the wire says about itself.

Source

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.

Source

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

A fresh decoder for one reply.

Provided Methods§

Source

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".

Trait Wire Copy item path

Required Associated Types§

type Op: Operation

type Payload: WasmCompatSend + 'static

type Frame: WasmCompatSend + 'static

type Event: WasmCompatSend + 'static

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

type Reassembler: Reassemble<Self::Event> + 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 Methods§

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

Dyn Compatibility§

Implementors§

impl Wire for CachedContents

type Op = ContextCache

type Payload = Encoded

type Frame = WireFrame

type Event = CachedContentReply

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 Event = ChatRecord

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 Event = ChatEvent

type Decoder<'id> = ChatDecoder

type Reassembler = ChatCompletion

impl Wire for CohereChat

type Op = Completion

type Payload = Encoded

type Frame = WireFrame

type Event = CohereEvent

type Decoder<'id> = CohereDecoder

type Reassembler = Routed

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

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Event = Result<EmbeddingResponse, String>

type Decoder<'id> = DocumentDecoder<Embedding, <Embeddings as Wire>::Event>

type Reassembler = Unreassembled

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

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Event = EmbeddingResponse

type Decoder<'id> = DocumentDecoder<<Embeddings as Wire>::Op, <Embeddings as Wire>::Event>

type Reassembler = Unreassembled

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

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Event = EmbeddingResponse

type Decoder<'id> = DocumentDecoder<Embedding, <Embeddings as Wire>::Event>

type Reassembler = Unreassembled

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

type Op = Embedding

type Payload = Encoded

type Frame = WireFrame

type Event = CompatibleEmbeddingResponse

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 Event = EmbeddingResponse

type Decoder<'id> = DocumentDecoder<Embedding, <Embeddings as Wire>::Event>

type Reassembler = Unreassembled

impl Wire for GenerateContent

Trait Wire