Skip to main content

UsageSink

Struct UsageSink 

Source
pub struct UsageSink(/* private fields */);
Expand description

A handle executors report usage through; cloning shares the observer.

Implementations§

Source§

impl UsageSink

Source

pub fn new(observer: Arc<dyn UsageObserver>) -> Self

Source

pub fn with_websocket( self, observer: Option<Arc<dyn WebSocketObserver>>, ) -> Self

Attach the attempt’s WebSocket response observer.

Source

pub fn websocket(&self) -> Option<Arc<dyn WebSocketObserver>>

The attached WebSocket response observer, if any.

Source

pub fn with_capture(self, capture: CaptureSink) -> Self

Attach request capture without changing ExecRequest construction sites.

Source

pub fn enabled(&self) -> bool

Whether anyone listens; executors can skip the work otherwise.

Source

pub fn wants_claude_cache(&self) -> bool

Source

pub fn claude_cache(&self, telemetry: ClaudeCacheTelemetry)

Source

pub fn response_body(&self, format: Format, body: &[u8])

Source

pub fn response_line(&self, format: Format, line: &[u8])

Source

pub fn response_usage_line(&self, format: Format, line: &[u8])

Source

pub fn request(&self, format: Format, payload: &[u8])

Source

pub fn plugin_executor(&self, provider: &str)

Source

pub fn delegated_executor(&self, executor_type: &str, model: &str)

Source

pub fn plugin_response_body(&self, protocol: &str, body: &[u8])

Source

pub fn plugin_response_line(&self, protocol: &str, line: &[u8])

Source

pub fn publish_failure_with_usage(&self, status: u16, body: &str)

Source

pub fn request_for(&self, identifier: &str, payload: &[u8])

Source

pub fn upstream_model(&self, model: &str)

Source

pub fn response_model(&self, model: &str)

Source

pub fn response_model_line(&self, line: &[u8])

Source

pub fn round_trip_started(&self)

Source

pub fn first_byte(&self)

Source

pub fn token_event(&self, is_token: bool)

Source

pub fn publish(&self)

Source

pub fn publish_failure(&self, status: u16, body: &str)

Source

pub fn usage_required(&self)

Source

pub fn discard(&self)

Source

pub fn upstream_stage(&self, stage: UpstreamStage)

Trait Implementations§

Source§

impl Clone for UsageSink

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for UsageSink

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UsageSink

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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