Struct Publisher 

pub struct Publisher { /* private fields */ }

A Publisher sends messages to a specific topic. It manages message batching and sending in a background task.

Publishers are created via a Client.

let client = Client::builder().build().await?;
let publisher = client.publisher("projects/my-project/topics/my-topic").build();
let message_id = publisher.publish(PubsubMessage::new().set_data("Hello, World"));

Implementations

impl Publisher

pub fn publish(&self, msg: PubsubMessage) -> PublishHandle

Publishes a message to the topic.

let message_id = publisher.publish(PubsubMessage::new().set_data("Hello, World")).await?;

pub async fn flush(&self)

Flushes all outstanding messages.

This method sends any messages that have been published but not yet sent, regardless of the configured batching options (delay_threshold, etc.).

This method is async and returns only after all publish attempts for the messages in the snapshot have completed. A “completed” attempt means the message has either been successfully sent, or has failed permanently after exhausting any applicable retry policies.

After flush()` returns, the final result of each individual publish operation (i.e., a success with a message ID or a terminal error) will be available on its corresponding PublishHandle.

Messages published after flush() is called will be buffered for a subsequent batch and are not included in this flush operation.

Example

// Publish some messages. They will be buffered according to batching options.
let handle1 = publisher.publish(PubsubMessage::new().set_data("foo".to_string()));
let handle2 = publisher.publish(PubsubMessage::new().set_data("bar".to_string()));

// Flush ensures that these messages are sent immediately and waits for
// the send to complete.
publisher.flush().await;

// The results for handle1 and handle2 are available.
let id1 = handle1.await?;
let id2 = handle2.await?;

Trait Implementations

impl Clone for Publisher

fn clone(&self) -> Publisher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Publisher

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

Formats the value using the given formatter.