Struct circulate::Relay

source ·
pub struct Relay { /* private fields */ }
Expand description

Manages subscriptions and notifications for PubSub.

Implementations§

source§

impl Relay

source

pub fn create_subscriber(&self) -> Subscriber

Create a new Subscriber for this relay.

source

pub fn publish<Topic: Serialize, P: Serialize>( &self, topic: &Topic, payload: &P ) -> Result<(), Error>

Publishes a payload to all subscribers of topic.

Errors

Returns an error if topic or payload fails to serialize with pot.

source

pub fn publish_raw<Topic: Into<OwnedBytes>, Payload: Into<OwnedBytes>>( &self, topic: Topic, payload: Payload )

Publishes a payload to all subscribers of topic.

source

pub fn publish_to_all<'topics, Topics: IntoIterator<Item = &'topics Topic> + 'topics, Topic: Serialize + 'topics, Payload: Serialize>( &self, topics: Topics, payload: &Payload ) -> Result<(), Error>

Publishes a payload to all subscribers of topic.

Errors

Returns an error if topics or payload fail to serialize with pot.

source

pub fn publish_raw_to_all( &self, topics: impl IntoIterator<Item = OwnedBytes>, payload: impl Into<OwnedBytes> )

Publishes a payload to all subscribers of topic.

source

pub fn publish_message(&self, message: &Message)

Publishes a message to all subscribers of its topic.

Trait Implementations§

source§

impl Clone for Relay

source§

fn clone(&self) -> Relay

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Relay

source§

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

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

impl Default for Relay

source§

fn default() -> Relay

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

Auto Trait Implementations§

§

impl !RefUnwindSafe for Relay

§

impl Send for Relay

§

impl Sync for Relay

§

impl Unpin for Relay

§

impl !UnwindSafe for Relay

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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.

source§

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.