Struct ProtoMessage 

pub struct ProtoMessage {
    pub metadata: HashMap<String, String>,
    pub message_type: Option<MessageType>,
}

Fields

metadata: HashMap<String, String>

message_type: Option<MessageType>

Implementations

impl ProtoMessage

pub fn validate(&self) -> Result<(), MessageError>

pub fn insert_metadata(&mut self, key: String, val: String)

pub fn remove_metadata(&mut self, key: &str) -> Option<String>

pub fn contains_metadata(&self, key: &str) -> bool

pub fn get_metadata(&self, key: &str) -> Option<&String>

pub fn get_metadata_map(&self) -> HashMap<String, String>

pub fn set_metadata_map(&mut self, map: HashMap<String, String>)

pub fn get_slim_header(&self) -> &SlimHeader

pub fn get_slim_header_mut(&mut self) -> &mut SlimHeader

pub fn try_get_slim_header(&self) -> Option<&SlimHeader>

pub fn get_session_header(&self) -> &SessionHeader

pub fn get_session_header_mut(&mut self) -> &mut SessionHeader

pub fn try_get_session_header(&self) -> Option<&SessionHeader>

pub fn try_get_session_header_mut(&mut self) -> Option<&mut SessionHeader>

pub fn get_id(&self) -> u32

pub fn get_source(&self) -> Name

pub fn get_dst(&self) -> Name

pub fn get_identity(&self) -> String

pub fn get_fanout(&self) -> u32

pub fn get_recv_from(&self) -> Option<u64>

pub fn get_forward_to(&self) -> Option<u64>

pub fn get_error(&self) -> Option<bool>

pub fn get_incoming_conn(&self) -> u64

pub fn try_get_incoming_conn(&self) -> Option<u64>

pub fn get_type(&self) -> &MessageType

pub fn get_payload(&self) -> Option<&Content>

pub fn set_payload(&mut self, payload: Content)

pub fn get_session_message_type(&self) -> SessionMessageType

pub fn clear_slim_header(&mut self)

pub fn set_recv_from(&mut self, recv_from: Option<u64>)

pub fn set_forward_to(&mut self, forward_to: Option<u64>)

pub fn set_error(&mut self, error: Option<bool>)

pub fn set_fanout(&mut self, fanout: u32)

pub fn set_incoming_conn(&mut self, incoming_conn: Option<u64>)

pub fn set_error_flag(&mut self, error: Option<bool>)

pub fn set_session_message_type(&mut self, message_type: SessionMessageType)

pub fn set_session_type(&mut self, session_type: ProtoSessionType)

pub fn get_session_type(&self) -> ProtoSessionType

pub fn set_message_id(&mut self, message_id: u32)

pub fn is_publish(&self) -> bool

pub fn is_subscribe(&self) -> bool

pub fn is_unsubscribe(&self) -> bool

pub fn is_link(&self) -> bool

pub fn is_subscription_ack(&self) -> bool

pub fn is_traceable(&self) -> bool

pub fn get_subscription_ack(&self) -> &ProtoSubscriptionAck

pub fn get_subscription_id(&self) -> Option<u64>

Returns the subscription_id from a Subscribe/Unsubscribe message, or None if absent/zero.

pub fn take_subscription_id(&mut self) -> Option<u64>

Takes and clears the subscription_id from a Subscribe/Unsubscribe message. Returns None if the field is absent or zero.

pub fn set_subscription_id(&mut self, subscription_id: u64)

Sets the subscription_id on a Subscribe/Unsubscribe message (no-op for other types).

pub fn extract_command_payload(&self) -> Result<&CommandPayload, MessageError>

Extracts the command payload from the message.

Errors

Returns MessageError if the payload is missing or cannot be converted.

pub fn extract_discovery_request( &self, ) -> Result<&DiscoveryRequestPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_discovery_reply( &self, ) -> Result<&DiscoveryReplyPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_join_request(&self) -> Result<&JoinRequestPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_join_reply(&self) -> Result<&JoinReplyPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_leave_request( &self, ) -> Result<&LeaveRequestPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_leave_reply(&self) -> Result<&LeaveReplyPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_add(&self) -> Result<&GroupAddPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_remove(&self) -> Result<&GroupRemovePayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_welcome( &self, ) -> Result<&GroupWelcomePayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_close(&self) -> Result<&GroupClosePayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_proposal( &self, ) -> Result<&GroupProposalPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_ack(&self) -> Result<&GroupAckPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_group_nack(&self) -> Result<&GroupNackPayload, MessageError>

Extracts a specific command payload from the message.

pub fn extract_ping(&self) -> Result<&PingPayload, MessageError>

Extracts a specific command payload from the message.

impl ProtoMessage

pub fn builder() -> ProtoMessageBuilder

Creates a new builder for ProtoMessage

Trait Implementations

impl AsRef<Publish> for ProtoMessage

fn as_ref(&self) -> &ProtoPublish

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl From<Message> for ProtoPublish

From ProtoMessage to ProtoPublish

fn from(message: ProtoMessage) -> Self

Converts to this type from the input type.

impl From<Message> for ProtoSubscribe

From ProtoMessage to ProtoSubscribe

fn from(message: ProtoMessage) -> Self

Converts to this type from the input type.

impl From<Message> for ProtoUnsubscribe

From ProtoMessage to ProtoUnsubscribe

fn from(message: ProtoMessage) -> Self

Converts to this type from the input type.

impl Message for Message

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Message

fn eq(&self, other: &Message) -> 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 Message