Struct UMessage

Source

#[repr(C)]
pub struct UMessage { /* private fields */ }

Expand description

One uProtocol message: attributes plus optional payload bytes.

Implementations§

Source §

impl UMessage

Source

pub fn extract_protobuf<T: ProtobufMappable>(&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::Protobuf nor UPayloadFormat::ProtobufWrappedInAny or if the bytes in the payload cannot be deserialized into the target type.

Source §

impl UMessage

Source

pub fn with_assumed_payload_encoding(self, encoding: &PayloadEncoding) -> Self

Returns this message with an assumed payload encoding stamped on its attributes when the message has payload bytes and no encoding declaration yet.

This is for transports whose wire profile fixes payload encoding by topic convention rather than carrying it per message. Existing encoding declarations are preserved unchanged.

Source

pub fn attributes(&self) -> &UAttributes

Get this message’s attributes.

This function simply delegates to UAttributes::type_.

§Example

use up_rust::{UMessageBuilder, UMessageType, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic).build()?;
assert_eq!(msg.type_(), UMessageType::Publish);

Source

pub fn type_(&self) -> UMessageType

Gets this message’s type.

Source

pub fn id(&self) -> &UUID

Gets this message’s identifier.

This function simply delegates to UAttributes::id.

§Example

use up_rust::{UMessageBuilder, UMessageType, UUri, UUID};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg_id = UUID::build();
let msg = UMessageBuilder::publish(topic).with_message_id(msg_id.clone()).build()?;
assert_eq!(msg.id(), &msg_id);

Source

pub fn source(&self) -> &UUri

Gets this message’s source address.

This function simply delegates to UAttributes::source.

§Example

use up_rust::{UMessageBuilder, UMessageType, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic.clone()).build()?;
assert_eq!(msg.source(), &topic);

Source

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

Gets this message’s sink address.

This function simply delegates to UAttributes::sink.

§Example

use up_rust::{UMessageBuilder, UMessageType, UUri};

let origin = UUri::try_from("//my-vehicle/D45/23/A001")?;
let dest = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::notification(origin, dest.clone()).build()?;
assert!(msg.sink().is_some_and(|sink| sink == &dest));

Source

pub fn sink_unchecked(&self) -> &UUri

Gets this message’s sink address.

This function simply delegates to UAttributes::sink_unchecked.

§Panics

if the property has no value.

§Example

use up_rust::{UMessageBuilder, UMessageType, UUri};

let origin = UUri::try_from("//my-vehicle/D45/23/A001")?;
let dest = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::notification(origin, dest.clone()).build()?;
assert_eq!(msg.sink_unchecked(), &dest);

Source

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

Gets this message’s priority.

This function simply delegates to UAttributes::priority.

§Example

use up_rust::{UMessageBuilder, UMessageType, UPriority, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic).with_priority(UPriority::CS3).build()?;
assert!(msg.priority().is_some_and(|prio| prio == UPriority::CS3));

Source

pub fn priority_unchecked(&self) -> UPriority

Gets this message’s priority.

This function simply delegates to UAttributes::priority_unchecked.

§Panics

if the property has no value.

§Example

use up_rust::{UMessageBuilder, UMessageType, UPriority, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic).with_priority(UPriority::CS3).build()?;
assert_eq!(msg.priority_unchecked(), UPriority::CS3);

Source

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

Gets this message’s commstatus.

This function simply delegates to UAttributes::commstatus.

§Example

use up_rust::{UCode, UMessageBuilder, UMessageType, UUID, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::response(reply_to, UUID::build(), invoked_method)
  .with_comm_status(UCode::Ok)
  .build()?;
assert!(msg.commstatus().is_some_and(|status| status == UCode::Ok));

Source

pub fn commstatus_unchecked(&self) -> UCode

Gets this message’s commstatus.

This function simply delegates to UAttributes::commstatus_unchecked.

§Panics

if the property has no value.

§Example

use up_rust::{UCode, UMessageBuilder, UMessageType, UUID, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::response(reply_to, UUID::build(), invoked_method)
  .with_comm_status(UCode::Internal)
  .build()?;
assert_eq!(msg.commstatus_unchecked(), UCode::Internal);

Source

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

Gets this message’s time-to-live.

This function simply delegates to UAttributes::ttl.

§Returns

the time-to-live in milliseconds.

§Example

use up_rust::{UMessageBuilder, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .build()?;
assert!(msg.ttl().is_some_and(|ttl| ttl == 5000));

Source

pub fn ttl_unchecked(&self) -> u32

Gets this message’s time-to-live.

This function simply delegates to UAttributes::ttl_unchecked.

§Returns

the time-to-live in milliseconds.

§Panics

if the property has no value.

§Example

use up_rust::{UMessageBuilder, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .build()?;
assert!(msg.ttl_unchecked() == 5000);

Source

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

Gets this message’s permission level.

This function simply delegates to UAttributes::permission_level.

§Example

use up_rust::{UMessageBuilder, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .with_permission_level(3)
  .build()?;
assert!(msg.permission_level().is_some_and(|pl| pl == 3));

Source

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

Gets this message’s token.

This function simply delegates to UAttributes::token.

§Example

use up_rust::{UMessageBuilder, UUri};

let token = "my_token";
let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .with_token(token)
  .build()?;
assert!(msg.token().is_some_and(|t| t == token));

Source

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

Gets this message’s traceparent.

This function simply delegates to UAttributes::traceparent.

§Example

use up_rust::{UMessageBuilder, UUri};

let traceparent = "my_traceparent";
let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .with_traceparent(traceparent)
  .build()?;
assert!(msg.traceparent().is_some_and(|tp| tp == traceparent));

Source

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

Gets this message’s request identifier.

This function simply delegates to UAttributes::request_id.

§Example

use up_rust::{UCode, UMessageBuilder, UUID, UUri};

let request_id = UUID::build();
let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::response(reply_to, request_id.clone(), invoked_method)
  .build()?;
assert!(msg.request_id().is_some_and(|id| id == &request_id));

Source

pub fn request_id_unchecked(&self) -> &UUID

Gets this message’s request identifier.

This function simply delegates to UAttributes::request_id_unchecked.

§Panics

if the property has no value.

§Example

use up_rust::{UCode, UMessageBuilder, UUID, UUri};

let request_id = UUID::build();
let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::response(reply_to, request_id.clone(), invoked_method)
  .build()?;
assert_eq!(msg.request_id_unchecked(), &request_id);

Source

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

Gets this message’s payload format.

This function simply delegates to UAttributes::payload_format.

§Example

use up_rust::{UMessageBuilder, UPayloadFormat, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic)
  .build_with_payload("hello".as_bytes(), UPayloadFormat::Text)?;
assert!(msg.payload_format().is_some_and(|format| format == UPayloadFormat::Text));

Source

pub fn payload_format_unchecked(&self) -> UPayloadFormat

Gets this message’s payload format.

This function simply delegates to UAttributes::payload_format_unchecked.

§Panics

if the property has no value.

§Example

use up_rust::{UMessageBuilder, UPayloadFormat, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic)
  .build_with_payload("hello".as_bytes(), UPayloadFormat::Text)?;
assert_eq!(msg.payload_format_unchecked(), UPayloadFormat::Text);

Source

pub fn payload(&self) -> Option<Bytes>

Returns the payload bytes, if the message carries any.

Source

pub fn is_publish(&self) -> bool

Checks if this is a Publish message.

This function simply delegates to UAttributes::is_publish.

§Examples

use up_rust::{UMessageBuilder, UUri};

let topic = UUri::try_from("//my-vehicle/D45/23/A001")?;
let msg = UMessageBuilder::publish(topic).build()?;
assert!(msg.is_publish());

Source

pub fn is_request(&self) -> bool

Checks if this is an RPC Request message.

This function simply delegates to UAttributes::is_request.

§Examples

use up_rust::{UMessageBuilder, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::request(invoked_method, reply_to, 5000)
  .build()?;
assert!(msg.is_request());

Source

pub fn is_response(&self) -> bool

Checks if this is an RPC Response message.

This function simply delegates to UAttributes::is_response.

§Examples

use up_rust::{UCode, UMessageBuilder, UUID, UUri};

let invoked_method = UUri::try_from("//my-vehicle/D45/2/101")?;
let reply_to = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::response(reply_to, UUID::build(), invoked_method)
  .build()?;
assert!(msg.is_response());

Source

pub fn is_notification(&self) -> bool

Checks if this is a Notification message.

This function simply delegates to UAttributes::is_notification.

§Examples

use up_rust::{UMessageBuilder, UUri};

let origin = UUri::try_from("//my-vehicle/D45/23/A001")?;
let dest = UUri::try_from("//other-vehicle/D10/3/0")?;
let msg = UMessageBuilder::notification(origin, dest).build()?;
assert!(msg.is_notification());