Struct UAttributes

pub struct UAttributes {

    pub id: MessageField<UUID>,
    pub type_: EnumOrUnknown<UMessageType>,
    pub source: MessageField<UUri>,
    pub sink: MessageField<UUri>,
    pub priority: EnumOrUnknown<UPriority>,
    pub ttl: Option<u32>,
    pub permission_level: Option<u32>,
    pub commstatus: Option<EnumOrUnknown<UCode>>,
    pub reqid: MessageField<UUID>,
    pub token: Option<String>,
    pub traceparent: Option<String>,
    pub payload_format: EnumOrUnknown<UPayloadFormat>,
    pub special_fields: SpecialFields,
}

Fields

id: MessageField<UUID>

type_: EnumOrUnknown<UMessageType>

source: MessageField<UUri>

sink: MessageField<UUri>

priority: EnumOrUnknown<UPriority>

ttl: Option<u32>

permission_level: Option<u32>

commstatus: Option<EnumOrUnknown<UCode>>

reqid: MessageField<UUID>

token: Option<String>

traceparent: Option<String>

payload_format: EnumOrUnknown<UPayloadFormat>

special_fields: SpecialFields

Implementations

impl UAttributes

pub fn is_publish(&self) -> bool

Checks if these are the attributes for a Publish message.

Examples

use up_rust::{UAttributes, UMessageType};

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

pub fn is_request(&self) -> bool

Checks if these are the attributes for an RPC Request message.

Examples

use up_rust::{UAttributes, UMessageType};

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

pub fn is_response(&self) -> bool

Checks if these are the attributes for an RPC Response message.

Examples

use up_rust::{UAttributes, UMessageType};

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

pub fn is_notification(&self) -> bool

Checks if these are the attributes for a Notification message.

Examples

use up_rust::{UAttributes, UMessageType};

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

pub fn check_expired(&self) -> Result<(), UAttributesError>

Checks if the message that is described by these attributes should be considered expired.

Errors

Returns an error if Self::ttl (time-to-live) contains a value greater than 0, but

• the message has expired according to the timestamp extracted from Self::id and the time-to-live value, or
• the current system time cannot be determined.

impl UAttributes

pub fn new() -> UAttributes

Trait Implementations

impl Clone for UAttributes

fn clone(&self) -> UAttributes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UAttributes

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

Formats the value using the given formatter.

impl<'a> Default for &'a UAttributes

fn default() -> &'a UAttributes

Returns the “default value” for a type.

impl Default for UAttributes

fn default() -> UAttributes

Returns the “default value” for a type.

impl Display for UAttributes

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

Formats the value using the given formatter.

impl Message for UAttributes

const NAME: &'static str = "UAttributes"

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() -> UAttributes

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static UAttributes

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 UAttributes

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for UAttributes

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

type RuntimeType = RuntimeTypeMessage<UAttributes>

Actual implementation of type properties.

impl StructuralPartialEq for UAttributes