Struct circulate::Relay

pub struct Relay { /* fields omitted */ }

Manages subscriptions and notifications for PubSub.

Implementations

impl Relay

pub async fn create_subscriber(&self) -> Subscriber

Create a new Subscriber for this relay.

pub async fn publish<S: Into<String> + Send, P: Serialize + Sync>(
    &self,
    topic: S,
    payload: &P
) -> Result<(), Error>

Publishes a payload to all subscribers of topic.

Errors

Returns an error if payload fails to serialize with serde_cbor.

pub async fn publish_to_all<P: Serialize + Sync>(
    &self,
    topics: Vec<String>,
    payload: &P
) -> Result<(), Error>

Publishes a payload to all subscribers of topic.

Errors

Returns an error if payload fails to serialize with serde_cbor.

pub async fn publish_serialized_to_all(
    &self,
    topics: Vec<String>,
    payload: Vec<u8>
)

Publishes a payload to all subscribers of topic.

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

Publishes a message to all subscribers of its topic.

Trait Implementations

impl Clone for Relay

fn clone(&self) -> Relay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Relay

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

Formats the value using the given formatter.

impl Default for Relay

fn default() -> Relay

Returns the “default value” for a type.