Struct UMessage

pub struct UMessage {
    pub attributes: MessageField<UAttributes>,
    pub payload: Option<Bytes>,
    pub special_fields: SpecialFields,
}

Fields

attributes: MessageField<UAttributes>

payload: Option<Bytes>

special_fields: SpecialFields

Implementations

impl UMessage

pub fn type_(&self) -> Option<UMessageType>

Gets this message’s type.

pub fn type_unchecked(&self) -> UMessageType

Gets this message’s type.

Panics

if the property has no value.

pub fn id(&self) -> Option<&UUID>

Gets this message’s identifier.

pub fn id_unchecked(&self) -> &UUID

Gets this message’s identifier.

Panics

if the property has no value.

pub fn source(&self) -> Option<&UUri>

Gets this message’s source address.

pub fn source_unchecked(&self) -> &UUri

Gets this message’s source address.

Panics

if the property has no value.

pub fn sink(&self) -> Option<&UUri>

Gets this message’s sink address.

pub fn sink_unchecked(&self) -> &UUri

Gets this message’s sink address.

Panics

if the property has no value.

pub fn priority(&self) -> Option<UPriority>

Gets this message’s priority.

pub fn priority_unchecked(&self) -> UPriority

Gets this message’s priority.

Panics

if the property has no value.

pub fn commstatus(&self) -> Option<UCode>

Gets this message’s commstatus.

pub fn commstatus_unchecked(&self) -> UCode

Gets this message’s commstatus.

Panics

if the property has no value.

pub fn ttl(&self) -> Option<u32>

Gets this message’s time-to-live.

Returns

the time-to-live in milliseconds.

pub fn ttl_unchecked(&self) -> u32

Gets this message’s time-to-live.

Returns

the time-to-live in milliseconds.

Panics

if the property has no value.

pub fn permission_level(&self) -> Option<u32>

Gets this message’s permission level.

pub fn token(&self) -> Option<&String>

Gets this message’s token.

pub fn traceparent(&self) -> Option<&String>

Gets this message’s traceparent.

pub fn request_id(&self) -> Option<&UUID>

Gets this message’s request identifier.

pub fn request_id_unchecked(&self) -> &UUID

Gets this message’s request identifier.

Panics

if the property has no value.

pub fn payload_format(&self) -> Option<UPayloadFormat>

Gets this message’s payload format.

pub fn payload_format_unchecked(&self) -> UPayloadFormat

Gets this message’s payload format.

Panics

if the property has no value.

pub fn is_publish(&self) -> bool

Checks if this is a Publish message.

Examples

use up_rust::{UAttributes, UMessage, UMessageType};

let attribs = UAttributes {
  type_: UMessageType::UMESSAGE_TYPE_PUBLISH.into(),
  ..Default::default()
};
let msg = UMessage {
  attributes: Some(attribs).into(),
  ..Default::default()
};
assert!(msg.is_publish());

pub fn is_request(&self) -> bool

Checks if this is an RPC Request message.

Examples

use up_rust::{UAttributes, UMessage, UMessageType};

let attribs = UAttributes {
  type_: UMessageType::UMESSAGE_TYPE_REQUEST.into(),
  ..Default::default()
};
let msg = UMessage {
  attributes: Some(attribs).into(),
  ..Default::default()
};
assert!(msg.is_request());

pub fn is_response(&self) -> bool

Checks if this is an RPC Response message.

Examples

use up_rust::{UAttributes, UMessage, UMessageType};

let attribs = UAttributes {
  type_: UMessageType::UMESSAGE_TYPE_RESPONSE.into(),
  ..Default::default()
};
let msg = UMessage {
  attributes: Some(attribs).into(),
  ..Default::default()
};
assert!(msg.is_response());

pub fn is_notification(&self) -> bool

Checks if this is a Notification message.

Examples

use up_rust::{UAttributes, UMessage, UMessageType};

let attribs = UAttributes {
  type_: UMessageType::UMESSAGE_TYPE_NOTIFICATION.into(),
  ..Default::default()
};
let msg = UMessage {
  attributes: Some(attribs).into(),
  ..Default::default()
};
assert!(msg.is_notification());

pub fn extract_protobuf<T: MessageFull + Default>( &self, ) -> Result<T, UMessageError>

Deserializes this message’s protobuf payload into a type.

Type Parameters

• T: The target type of the data to be unpacked.

Errors

Returns an error if the message payload format is neither UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF nor UPayloadFormat::UPAYLOAD_FORMAT_PROTOBUF_WRAPPED_IN_ANY or if the bytes in the payload cannot be deserialized into the target type.

impl UMessage

pub fn new() -> UMessage

Trait Implementations

impl Clone for UMessage

fn clone(&self) -> UMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UMessage

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

Formats the value using the given formatter.

impl<'a> Default for &'a UMessage

fn default() -> &'a UMessage

Returns the “default value” for a type.

impl Default for UMessage

fn default() -> UMessage

Returns the “default value” for a type.

impl Display for UMessage

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

Formats the value using the given formatter.

impl Message for UMessage

const NAME: &'static str = "UMessage"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> UMessage

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static UMessage

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>

Write the message to the stream.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_>, ) -> Result<(), Error>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self, Error>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<(), Error>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<(), Error>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to bytes vec.

fn write_length_delimited_to_writer( &self, w: &mut dyn Write, ) -> Result<(), Error>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for UMessage

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq for UMessage

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

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

const 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 ProtobufValue for UMessage

type RuntimeType = RuntimeTypeMessage<UMessage>

Actual implementation of type properties.

impl TryFrom<CloudEvent> for UMessage

type Error = UMessageError

The type returned in the event of a conversion error.

fn try_from(event: CloudEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UMessage> for CloudEvent

type Error = UMessageError

The type returned in the event of a conversion error.

fn try_from(message: UMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for UMessage