Skip to main content

TransientEventBus

Struct TransientEventBus 

Source
pub struct TransientEventBus<T, R = ()> { /* private fields */ }
Expand description

Process-local event broadcast paired with an optional shared transport.

The local channel is always available, including in single-process deployments and tests. Products decide how to encode events for R, how to publish through it, and how remote items are decoded back into the local channel.

Implementations§

Source§

impl<T, R> TransientEventBus<T, R>
where T: Clone,

Source

pub fn new(capacity: usize) -> Self

Creates a process-local bus without a shared transport.

Source

pub fn with_transport(capacity: usize, transport: R) -> Self

Creates a bus with a shared transport.

Source

pub fn from_optional_transport(capacity: usize, transport: Option<R>) -> Self

Creates a bus from an optional shared transport.

Source

pub fn publish_local(&self, event: T) -> Result<usize, SendError<T>>

Publishes one event to process-local subscribers.

Source

pub fn subscribe(&self) -> Receiver<T>

Subscribes to future process-local events.

Source

pub fn local_subscriber_count(&self) -> usize

Returns the number of active process-local subscribers.

Source

pub fn has_transport(&self) -> bool

Returns whether a shared transport is configured.

Source

pub fn transport(&self) -> Option<Arc<R>>

Returns the shared transport, if configured.

Trait Implementations§

Source§

impl<T, R> Clone for TransientEventBus<T, R>

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

Auto Trait Implementations§

§

impl<T, R> Freeze for TransientEventBus<T, R>

§

impl<T, R = ()> !RefUnwindSafe for TransientEventBus<T, R>

§

impl<T, R> Send for TransientEventBus<T, R>
where R: Sync + Send, T: Send,

§

impl<T, R> Sync for TransientEventBus<T, R>
where R: Sync + Send, T: Send,

§

impl<T, R> Unpin for TransientEventBus<T, R>

§

impl<T, R> UnsafeUnpin for TransientEventBus<T, R>

§

impl<T, R = ()> !UnwindSafe for TransientEventBus<T, R>

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.

§

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> 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.
§

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