Struct CallOptions

pub struct CallOptions { /* private fields */ }

General options that clients might want to specify when sending a uProtocol message.

Implementations

impl CallOptions

pub fn for_rpc_request( ttl: u32, message_id: Option<UUID>, token: Option<String>, priority: Option<UPriority>, ) -> Self

Creates new call options for an RPC Request.

Arguments

• ttl - The message’s time-to-live in milliseconds.
• message_id - The identifier to use for the message or None to use a generated identifier.
• token - The token to use for authenticating to infrastructure and service endpoints.
• priority - The message’s priority or None to use the default priority for RPC Requests.

Returns

Options suitable for invoking an RPC method.

Examples

use up_rust::{UPriority, UUID, communication::CallOptions};

let uuid = UUID::new();
let options = CallOptions::for_rpc_request(15_000, Some(uuid.clone()), Some("token".to_string()), Some(UPriority::UPRIORITY_CS6));
assert_eq!(options.ttl(), 15_000);
assert_eq!(options.message_id(), Some(uuid));
assert_eq!(options.token(), Some("token".to_string()));
assert_eq!(options.priority(), Some(UPriority::UPRIORITY_CS6));

pub fn for_notification( ttl: Option<u32>, message_id: Option<UUID>, priority: Option<UPriority>, ) -> Self

Creates new call options for a Notification message.

Arguments

• ttl - The message’s time-to-live in milliseconds.
• message_id - The identifier to use for the message or None to use a generated identifier.
• priority - The message’s priority or None to use the default priority for Notifications.

Returns

Options suitable for sending a Notification.

Examples

use up_rust::{UPriority, UUID, communication::CallOptions};

let uuid = UUID::new();
let options = CallOptions::for_notification(Some(15_000), Some(uuid.clone()), Some(UPriority::UPRIORITY_CS2));
assert_eq!(options.ttl(), 15_000);
assert_eq!(options.message_id(), Some(uuid));
assert_eq!(options.priority(), Some(UPriority::UPRIORITY_CS2));

pub fn for_publish( ttl: Option<u32>, message_id: Option<UUID>, priority: Option<UPriority>, ) -> Self

Creates new call options for a Publish message.

Arguments

• ttl - The message’s time-to-live in milliseconds or None if the message should not expire at all.
• message_id - The identifier to use for the message or None to use a generated identifier.
• priority - The message’s priority or None to use the default priority for Publish messages.

Returns

Options suitable for sending a Publish message.

Examples

use up_rust::{UPriority, UUID, communication::CallOptions};

let uuid = UUID::new();
let options = CallOptions::for_publish(Some(15_000), Some(uuid.clone()), Some(UPriority::UPRIORITY_CS2));
assert_eq!(options.ttl(), 15_000);
assert_eq!(options.message_id(), Some(uuid));
assert_eq!(options.priority(), Some(UPriority::UPRIORITY_CS2));

pub fn ttl(&self) -> u32

Gets the message’s time-to-live in milliseconds.

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

Gets the identifier to use for the message.

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

Gets the token to use for authenticating to infrastructure and service endpoints.

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

Gets the message’s priority.

Trait Implementations

impl Clone for CallOptions

fn clone(&self) -> CallOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallOptions

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

Formats the value using the given formatter.

impl PartialEq for CallOptions

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