Skip to main content

CallOptions

Struct CallOptions 

Source
pub struct CallOptions {
    pub scope: Option<ScopeSelector>,
    pub timeout: Duration,
    pub priority: Priority,
    pub admission_class: AdmissionClass,
    pub route_retry: RetryBackoff,
    pub route_retry_deadline: Duration,
    pub consumer_identity: Option<ConsumerIdentity>,
    pub reverse_requests: ReverseRequestRegistry,
    pub role_versions: Option<BTreeMap<String, String>>,
}
Expand description

Per-call options for SubcConsumer::call.

Fields§

§scope: Option<ScopeSelector>

Scope for a managed call’s cached route, including reconnect reopens. Each owner/ref/epoch has a separate cache entry, apart from unscoped routes. Admission, retries and terminal refusals follow SubcConsumer::open_route_scoped. A later call after a scope-related close tries a fresh route; the daemon refuses it as scope_ended for an old epoch or scope_not_live if the scope ref is gone. No tombstone is cached. Defaults to None. Methods using an already-open handle reject this option; select the scope when opening the route instead.

§timeout: Duration

Deadline for the whole managed call, including route-open retry and the response wait.

§priority: Priority§admission_class: AdmissionClass

Admission behavior stamped into the request frame. Defaults to NORMAL.

§route_retry: RetryBackoff§route_retry_deadline: Duration

Maximum real-time limit for retrying route.open attempts when the target is temporarily absent. Bounds the whole route open, including the first attempt: a zero budget means no open is attempted. For a single attempt, allow that attempt’s time.

§consumer_identity: Option<ConsumerIdentity>

Explicit consumer identity for route.open; when absent, the supervised launch identity is used, except on SubcConsumer::connect_operator_app connections, which omit implicit identity. A claim-bound connection rejects legacy nonce identity overrides as not sent, rather than changing the connection’s authority.

§reverse_requests: ReverseRequestRegistry

Reverse-request handlers plus extra capability strings added with Self::with_consumer_capability. For example, tool-result/v1 declares tool-provider content-result support. These declarations are unverified and grant nothing; both sets are merged and omitted when empty.

§role_versions: Option<BTreeMap<String, String>>

The versions of provider roles this consumer speaks on the route, role name to version ({"tool-provider": "v1"}), sent on route.open and forwarded by the daemon to the provider’s bind. An unverified declaration that grants nothing. Routes that differ only here are separate routes, so a legacy route and a versioned one to the same target are never shared; an empty map is the same as None.

A daemon that does not advertise route-role-versions/v1 (subc_protocol::scope::CAP_ROUTE_ROLE_VERSIONS_V1) drops the field without telling the provider, so check the capability before relying on it. A malformed map (see subc_protocol::session::validate_role_versions) is refused by the daemon as invalid_request and the call fails as not sent.

Implementations§

Source§

impl CallOptions

Source

pub fn with_consumer_capability( self, capability: impl Into<String>, ) -> Result<Self, ConsumerCapabilityError>

Add a provider-contract capability declaration to the route.

The list is merged with reverse-request handler families, sorted and de-duplicated. For example, tool-result/v1 declares the tool-provider content result format. This remains an unverified declaration and grants no privilege. Invalid values are rejected here, before route.open can be sent.

Like reverse-request handlers, declarations are kept in the options’ shared reverse-request state, so options cloned before this call share the declaration. Add declarations before cloning options for other routes.

Source

pub fn consumer_capabilities(&self) -> Vec<String>

The extra capability strings added with with_consumer_capability, not the reverse-request handler families. For example, tool-result/v1 declares tool-provider content-result support; declarations are unverified and grant nothing.

Trait Implementations§

Source§

impl Clone for CallOptions

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 CallOptions

Source§

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

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

impl Default for CallOptions

Source§

fn default() -> Self

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

impl Eq for CallOptions

Source§

impl PartialEq for CallOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CallOptions

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