Skip to main content

Translator

Struct Translator 

Source
pub struct Translator<C> { /* private fields */ }
Expand description

Turns a reply into one the downstream client can read.

Implementations§

Source§

impl<C: ToolResultCodec> Translator<C>

Source

pub const fn new(codec: C) -> Self

A translator over one codec.

Source

pub fn translate( &self, reply: Map<String, Value>, from: ProtocolVersion, to: &Leg, policy: DegradePolicy, ) -> Result<Translated, LowerError>

Translates reply — which arrived in from’s encoding — into something the to leg negotiated for.

Returns the reply untouched with an empty report whenever there is nothing to decide. That is the common case and it is deliberate: see the module docs for why rebuilding an untranslated reply is a bug rather than a thoroughness.

§Errors

LowerError when the reply needs a downgrade policy does not authorise, or when the codec cannot write the lowered value at to. The caller refuses on the error rather than forwarding a result the client cannot read.

§Examples

A result the client can read is handed back exactly as it arrived.

use protocol_droid::application::bridge::{ToolResultCodec, Translator};
use protocol_droid::domain::ir::{LowerError, ToolResult, TranslationReport};
use protocol_droid::domain::{
    CapabilitySet, DegradePolicy, Leg, Negotiation, ProtocolVersion, TransportKind, resolve,
};
use serde_json::{Map, Value, json};

struct ReadsNothing;

impl ToolResultCodec for ReadsNothing {
    fn lift(&self, _version: ProtocolVersion, _wire: &Value) -> Option<ToolResult> {
        None
    }

    fn lower(
        &self,
        _version: ProtocolVersion,
        _value: ToolResult,
        _policy: DegradePolicy,
        _report: &mut TranslationReport,
    ) -> Result<Value, LowerError> {
        Ok(Value::Null)
    }
}

let version = ProtocolVersion::V2025_03_26;
let caps = CapabilitySet::all_for(version);
let leg = Leg::new(
    version,
    resolve(Negotiation {
        version,
        client_caps: caps,
        server_caps: caps,
        transport: TransportKind::Stdio,
    }),
);

let reply: Map<String, Value> = serde_json::from_value(json!({
    "jsonrpc": "2.0",
    "id": 1,
    "result": { "content": [{ "type": "text", "text": "hi" }] },
}))?;

let translator = Translator::new(ReadsNothing);
let translated =
    translator.translate(reply.clone(), version, &leg, DegradePolicy::strict())?;

assert_eq!(translated.reply, reply);
assert!(translated.report.is_empty());

Trait Implementations§

Source§

impl<C: Debug> Debug for Translator<C>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Translator<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for Translator<C>
where C: RefUnwindSafe,

§

impl<C> Send for Translator<C>
where C: Send,

§

impl<C> Sync for Translator<C>
where C: Sync,

§

impl<C> Unpin for Translator<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for Translator<C>
where C: UnsafeUnpin,

§

impl<C> UnwindSafe for Translator<C>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more