Struct GtpMessage 

pub struct GtpMessage {
    pub message_id: u64,
    pub sender_id: u32,
    pub timestamp_ms: u64,
    pub request_id: u32,
    pub flags: u8,
    pub content_type: u8,
    pub content_length: u32,
    pub content: ByteBuf,
}

GTP message envelope. Eight CBOR keys.

Fields

message_id: u64

Message identifier (used for idempotency).

sender_id: u32

Sender member identifier.

timestamp_ms: u64

Send timestamp in milliseconds since the Unix epoch.

request_id: u32

Request identifier (echoed in ACK / NACK).

flags: u8

Message flag bits (urgent / ephemeral / persistent).

content_type: u8

content_type (see GtpContentType).

content_length: u32

Declared length of content.

content: ByteBuf

Body bytes.

Implementations

impl GtpMessage

pub fn plain(sender_id: u32, message_id: u64, text: &str) -> GtpMessage

Builds a plaintext (UTF-8) message.

pub fn to_cbor(&self) -> Vec<u8>

CBOR-encodes the message.

pub fn from_cbor(data: &[u8]) -> Result<GtpMessage, CodecError>

Decodes a CBOR-encoded message and validates content_length.

pub fn text(&self) -> Option<&str>

Returns the body as a &str when it is valid UTF-8.

pub fn to_bytes(&self, codec: PayloadCodec) -> Vec<u8>

Encodes the message using the given codec.

pub fn from_bytes( data: &[u8], codec: PayloadCodec, ) -> Result<GtpMessage, CodecError>

Decodes a message from the given codec.

Trait Implementations

impl Clone for GtpMessage

fn clone(&self) -> GtpMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GtpMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GtpMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<GtpMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GtpMessage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<GtpMessage> for GtpMessage

type Error = ()

The type returned in the event of a conversion error.

fn try_from(p: GtpMessage) -> Result<GtpMessage, ()>

Performs the conversion.

impl<'a> TryFrom<GtpMessageRef<'a>> for GtpMessage

type Error = ()

The type returned in the event of a conversion error.

fn try_from(r: GtpMessageRef<'a>) -> Result<GtpMessage, ()>

Performs the conversion.