Struct async_nats::jetstream::context::Publish

pub struct Publish { /* private fields */ }

Used for building customized publish message.

Implementations

impl Publish

pub fn build() -> Self

Creates a new custom Publish struct to be used with.

Examples found in repository

src/jetstream/context.rs (line 121)

    pub async fn publish(
        &self,
        subject: String,
        payload: Bytes,
    ) -> Result<PublishAckFuture, Error> {
        self.send_publish(subject, Publish::build().payload(payload))
            .await
    }

    /// Publish a message with headers to a given subject associated with a stream and returns an acknowledgment from
    /// the server that the message has been successfully delivered.
    ///
    /// If the stream does not exist, `no responders` error will be returned.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), async_nats::Error> {
    /// let client = async_nats::connect("localhost:4222").await?;
    /// let jetstream = async_nats::jetstream::new(client);
    ///
    /// let mut headers = async_nats::HeaderMap::new();
    /// headers.append("X-key", "Value");
    /// let ack = jetstream.publish_with_headers("events".to_string(), headers, "data".into()).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn publish_with_headers(
        &self,
        subject: String,
        headers: crate::header::HeaderMap,
        payload: Bytes,
    ) -> Result<PublishAckFuture, Error> {
        self.send_publish(subject, Publish::build().payload(payload).headers(headers))
            .await
    }

pub fn payload(self, payload: Bytes) -> Self

Sets the payload for the message.

Examples found in repository

src/jetstream/context.rs (line 121)

    pub async fn publish(
        &self,
        subject: String,
        payload: Bytes,
    ) -> Result<PublishAckFuture, Error> {
        self.send_publish(subject, Publish::build().payload(payload))
            .await
    }

    /// Publish a message with headers to a given subject associated with a stream and returns an acknowledgment from
    /// the server that the message has been successfully delivered.
    ///
    /// If the stream does not exist, `no responders` error will be returned.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), async_nats::Error> {
    /// let client = async_nats::connect("localhost:4222").await?;
    /// let jetstream = async_nats::jetstream::new(client);
    ///
    /// let mut headers = async_nats::HeaderMap::new();
    /// headers.append("X-key", "Value");
    /// let ack = jetstream.publish_with_headers("events".to_string(), headers, "data".into()).await?;
    /// # Ok(())
    /// # }
    /// ```
    pub async fn publish_with_headers(
        &self,
        subject: String,
        headers: crate::header::HeaderMap,
        payload: Bytes,
    ) -> Result<PublishAckFuture, Error> {
        self.send_publish(subject, Publish::build().payload(payload).headers(headers))
            .await
    }

pub fn headers(self, headers: HeaderMap) -> Self

Adds headers to the message.

Examples found in repository

src/jetstream/context.rs (line 150)

    pub async fn publish_with_headers(
        &self,
        subject: String,
        headers: crate::header::HeaderMap,
        payload: Bytes,
    ) -> Result<PublishAckFuture, Error> {
        self.send_publish(subject, Publish::build().payload(payload).headers(headers))
            .await
    }

pub fn header<N: IntoHeaderName, V: IntoHeaderValue>(
    self,
    name: N,
    value: V
) -> Self

A shorthand to add a single header.

Examples found in repository

src/jetstream/context.rs (line 904)

    pub fn message_id<T: AsRef<str>>(self, id: T) -> Self {
        self.header(header::NATS_MESSAGE_ID, id.as_ref())
    }
    /// Sets expected last message ID.
    /// It sets the `Nats-Expected-Last-Msg-Id` header with provided value.
    pub fn expected_last_message_id<T: AsRef<str>>(self, last_message_id: T) -> Self {
        self.header(
            header::NATS_EXPECTED_LAST_MESSAGE_ID,
            last_message_id.as_ref(),
        )
    }
    /// Sets the last expected stream sequence.
    /// It sets the `Nats-Expected-Last-Sequence` header with provided value.
    pub fn expected_last_sequence(self, last_sequence: u64) -> Self {
        self.header(
            header::NATS_EXPECTED_LAST_SEQUENCE,
            HeaderValue::from(last_sequence),
        )
    }
    /// Sets the last expected stream sequence for a subject this message will be published to.
    /// It sets the `Nats-Expected-Last-Subject-Sequence` header with provided value.
    pub fn expected_last_subject_sequence(self, subject_sequence: u64) -> Self {
        self.header(
            header::NATS_EXPECTED_LAST_SUBJECT_SEQUENCE,
            HeaderValue::from(subject_sequence),
        )
    }
    /// Sets the expected stream name.
    /// It sets the `Nats-Expected-Stream` header with provided value.
    pub fn expected_stream<T: AsRef<str>>(self, stream: T) -> Self {
        self.header(
            header::NATS_EXPECTED_STREAM,
            HeaderValue::from(stream.as_ref()),
        )
    }

pub fn message_id<T: AsRef<str>>(self, id: T) -> Self

Sets the Nats-Msg-Id header, that is used by stream deduplicate window.

pub fn expected_last_message_id<T: AsRef<str>>(self, last_message_id: T) -> Self

Sets expected last message ID. It sets the Nats-Expected-Last-Msg-Id header with provided value.

pub fn expected_last_sequence(self, last_sequence: u64) -> Self

Sets the last expected stream sequence. It sets the Nats-Expected-Last-Sequence header with provided value.

pub fn expected_last_subject_sequence(self, subject_sequence: u64) -> Self

Sets the last expected stream sequence for a subject this message will be published to. It sets the Nats-Expected-Last-Subject-Sequence header with provided value.

pub fn expected_stream<T: AsRef<str>>(self, stream: T) -> Self

Sets the expected stream name. It sets the Nats-Expected-Stream header with provided value.

Trait Implementations

impl Clone for Publish

fn clone(&self) -> Publish

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Publish

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

Formats the value using the given formatter.

impl Default for Publish

fn default() -> Publish

Returns the “default value” for a type.