Skip to main content

SubscribeOptions

Struct SubscribeOptions 

Source
pub struct SubscribeOptions {
    pub token: Option<PermissionToken>,
}
Expand description

Options passed to Mesh::subscribe_channel_with.

Today the only knob is a presented PermissionToken — the shape is a struct rather than a bare Option<Token> so future additions (request-side timeout override, subscribe priority, etc.) don’t break callers.

§Round-trip shape

// Publisher issues a SUBSCRIBE-scope token for the subscriber.
// The publisher's own `Mesh` is bound to an `Identity`, so the
// token lands in its local cache when `issue_token` is called.
let channel = ChannelName::new("events/trades").unwrap();
let token = publisher_identity.issue_token(
    subscriber_entity_id,
    TokenScope::SUBSCRIBE,
    &channel,
    Duration::from_secs(600),
    0, // no further delegation
);

// Subscriber (another `Mesh`) calls `subscribe_channel_with`,
// attaching the same token bytes they received from the
// publisher out of band. The publisher verifies the signature,
// checks `subject == subscriber_entity_id`, installs it in its
// cache, then runs `can_subscribe`.
let subscriber: &net_sdk::Mesh = unimplemented!();
subscriber
    .subscribe_channel_with(
        publisher.node_id(),
        &channel,
        SubscribeOptions { token: Some(token) },
    )
    .await?;

Fields§

§token: Option<PermissionToken>

Token to attach to the subscribe request. The publisher verifies + installs it before running ChannelConfig::can_subscribe, so a matching token satisfies require_token channels end-to-end.

Trait Implementations§

Source§

impl Clone for SubscribeOptions

Source§

fn clone(&self) -> SubscribeOptions

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 SubscribeOptions

Source§

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

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

impl Default for SubscribeOptions

Source§

fn default() -> SubscribeOptions

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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