Struct nats_types::UnsubscribeMessage

pub struct UnsubscribeMessage {
    pub subscription_id: usize,
    pub max_messages: Option<usize>,
}

A struct that represents an unsubscribe message. This message conforms to the following format from the NATS protocol definition:

UNSUB <sid> [max_msgs]

Fields

subscription_id: usize

max_messages: Option<usize>

Methods

impl UnsubscribeMessage

pub fn new(
    subscription_id: usize,
    max_messages: Option<usize>
) -> UnsubscribeMessage

Constructor to create a new unsub message

pub fn as_vec(
    subscription_id: usize,
    max_messages: Option<usize>
) -> Result<Vec<u8>, Box<dyn Error>>

Efficient single-allocation conversion to a byte vector suitable for network transmission

Trait Implementations

impl PartialEq<UnsubscribeMessage> for UnsubscribeMessage

fn eq(&self, other: &UnsubscribeMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UnsubscribeMessage) -> bool

This method tests for !=.

impl Clone for UnsubscribeMessage

fn clone(&self) -> UnsubscribeMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnsubscribeMessage

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

Formats the value using the given formatter.

impl Display for UnsubscribeMessage

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

Formats the value using the given formatter.

impl FromStr for UnsubscribeMessage

type Err = NatsParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.