Preview of the proposed up-rust native-frame-model branch (up-rust b6b99c6d, up-spec f0e9b17) — not released documentation. branch · write-up

Struct Subscriber

Source
pub struct Subscriber<T>{ /* private fields */ }
Expand description

Role: the up-L2 subscribe surface over a selected-wire zero-copy transport (experimental) — see the trait map.

Mirrors the owned-frame Subscriber: the uSubscription service is informed first, and the zero-copy listener is registered only when the service reports the subscription active or pending. Received payloads are delivered as the transport’s lease type — for a selected-wire transport that is UWireRx, whose decode_payload reads the typed value in place.

Implementations§

Source§

impl<T> Subscriber<T>

Source

pub fn new(transport: Arc<T>, usubscription: Arc<dyn USubscription>) -> Self

Creates a subscriber over a zero-copy transport and a uSubscription service client.

Source

pub async fn subscribe( &self, topic: &UUri, listener: Arc<dyn UZeroCopyListener<T::Rx>>, ) -> Result<(), RegistrationError>

Subscribes to a topic: informs the uSubscription service first, then registers the zero-copy listener on success.

§Errors

Returns an error if the topic is not a valid subscription filter, if the uSubscription service rejects the subscription or reports a state other than active/pending, or if listener registration fails.

Source

pub async fn unsubscribe( &self, topic: &UUri, listener: Arc<dyn UZeroCopyListener<T::Rx>>, ) -> Result<(), RegistrationError>

Unsubscribes from a topic: informs the uSubscription service, then unregisters the zero-copy listener.

§Errors

Returns an error if the topic is not a valid subscription filter, or if the service call or listener unregistration fails.

Trait Implementations§

Source§

impl<T> Debug for Subscriber<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Subscriber<T>
where T: ?Sized,

§

impl<T> !RefUnwindSafe for Subscriber<T>

§

impl<T> Send for Subscriber<T>
where T: ?Sized,

§

impl<T> Sync for Subscriber<T>
where T: ?Sized,

§

impl<T> Unpin for Subscriber<T>
where T: ?Sized,

§

impl<T> !UnwindSafe for Subscriber<T>

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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, 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<TCore> UWithNativePrefixWire for TCore

Source§

fn into_native_prefix_wire_transport<W>( self, wire: W, ) -> UWireTransport<TCore, W, NativePrefixFrameMetadataCodec>
where W: UWire,

Wraps this core with an external or custom selected wire using canonical metadata.
Source§

fn into_protobuf_transport( self, ) -> UWireTransport<TCore, ProtobufWire, NativePrefixFrameMetadataCodec>

Wraps this core with the Protocol Buffers selected-wire profile.
Source§

fn into_stable_container_transport( self, ) -> UWireTransport<TCore, StableContainerWireFormat, NativePrefixFrameMetadataCodec>

Wraps this core with the stable-container selected-wire profile.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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