Skip to main content

Options

Struct Options 

Source
pub struct Options {
    pub adapter_name: String,
    pub adapter_version: String,
    pub capabilities: Vec<Capability>,
    pub limits: Limits,
    pub write_timeout: Option<Duration>,
    pub probe: Option<ProbeInfo>,
    pub debug: Option<Arc<DebugLog>>,
    pub evidence_registry: Option<Registry>,
}
Expand description

How a client identifies itself and what it can provide.

Fields§

§adapter_name: String

Adapter name sent in the handshake.

§adapter_version: String

Adapter version sent in the handshake.

§capabilities: Vec<Capability>

Capabilities announced to the driver.

§limits: Limits

Limits in force until hello-ack replaces them.

§write_timeout: Option<Duration>

Bound on a single frame write. None disables it, which is only sane for a caller that publishes off the render path.

§probe: Option<ProbeInfo>

What a probe says it can observe. None for a hand-written adapter, which is what the driver assumes by default.

§debug: Option<Arc<DebugLog>>

Adapter-side diagnostic log, or None for silence — which is what Options::new leaves here unless TERMWRIGHT_DEBUG_FILE names a file. Shared rather than owned so an adapter can log alongside the client on the same file.

§evidence_registry: Option<Registry>

Application evidence registry frozen before hello.

Implementations§

Source§

impl Options

Source

pub fn with_logs( adapter_name: impl Into<String>, adapter_version: impl Into<String>, ) -> Self

Options for an adapter that also forwards application logs.

Announcing logs is what makes the driver grant a budget; without it the driver sends none and the adapter must stay silent.

Source

pub fn new( adapter_name: impl Into<String>, adapter_version: impl Into<String>, ) -> Self

Options for an adapter with the default capability set.

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Options

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 Options

Source§

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

Formats the value using the given formatter. 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, 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.