Struct 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>

Implementations

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 Clone for UnsubscribeMessage

fn clone(&self) -> UnsubscribeMessage

Returns a duplicate of the value.

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 as FromStr>::Err>

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

impl PartialEq for UnsubscribeMessage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UnsubscribeMessage