Struct UUri

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

A URI that represents a uProtocol resource identifier.

Implementations

impl UUri

pub fn to_uri(&self, include_scheme: bool) -> String

Serializes this UUri to a URI string.

Arguments

• include_scheme - Indicates whether to include the uProtocol scheme (up) in the URI.

Returns

The URI as defined by the uProtocol Specification.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin.vehicles", 0x0000_800A, 0x02, 0x1a50).unwrap();
let uri_string = uuri.to_uri(true);
assert_eq!(uri_string, "up://vin.vehicles/800A/2/1A50");

pub fn try_from_parts( authority: &str, entity_id: u32, entity_version: u8, resource_id: u16, ) -> Result<Self, UUriError>

Creates a new UUri from its parts.

Errors

Returns a UUriError::ValidationError if the authority does not comply with the UUri specification.

Examples

use up_rust::UUri;

assert!(UUri::try_from_parts("vin", 0x0000_5a6b, 0x01, 0x0001).is_ok());

pub fn any() -> Self

Gets a pattern URI that matches any given candidate URI.

pub fn any_with_resource_id(resource_id: u16) -> Self

Gets a pattern URI that matches any given candidate URI with a specific resource ID.

pub fn authority_name(&self) -> &str

Gets the authority name part from this uProtocol URI.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("my-vehicle", 0x10101234, 0x01, 0x9a10).unwrap();
assert_eq!(uri.authority_name(), "my-vehicle");

pub fn uentity_type_id(&self) -> u16

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("my-vehicle", 0x10101234, 0x01, 0x9a10).unwrap();
assert_eq!(uri.uentity_type_id(), 0x1234);

pub fn uentity_instance_id(&self) -> u16

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("my-vehicle", 0x10101234, 0x01, 0x9a10).unwrap();
assert_eq!(uri.uentity_instance_id(), 0x1010);

pub fn uentity_major_version(&self) -> u8

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("my-vehicle", 0x10101234, 0x01, 0x9a10).unwrap();
assert_eq!(uri.uentity_major_version(), 0x01);

pub fn resource_id(&self) -> u16

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("my-vehicle", 0x10101234, 0x01, 0x9a10).unwrap();
assert_eq!(uri.resource_id(), 0x9a10);

pub fn clone_with_resource_id(&self, resource_id: u16) -> Self

Returns a copy of this URI with the resource id replaced.

pub fn verify_authority(authority: &str) -> Result<(), UUriError>

Verifies that the given authority name complies with the UUri specification.

Arguments

• authority - The authority name to verify.

Errors

Returns an error if the authority name is invalid.

Examples

use up_rust::UUri;

assert!(UUri::verify_authority("my.vin").is_ok());

pub fn is_remote(&self, other_uri: &UUri) -> bool

Check if an UUri is remote, by comparing authority fields. UUris with empty authority are considered to be local.

Returns

‘true’ if other_uri has a different authority than Self, false otherwise.

Examples

use std::str::FromStr;
use up_rust::UUri;

let authority_a = UUri::from_str("up://authority.a/100A/1/0").unwrap();
let authority_b = UUri::from_str("up://authority.b/200B/2/20").unwrap();
assert!(authority_a.is_remote(&authority_b));

let authority_local = UUri::from_str("up:///100A/1/0").unwrap();
assert!(!authority_local.is_remote(&authority_a));

let authority_wildcard = UUri::from_str("up://*/100A/1/0").unwrap();
assert!(!authority_wildcard.is_remote(&authority_a));
assert!(!authority_a.is_remote(&authority_wildcard));
assert!(!authority_wildcard.is_remote(&authority_wildcard));

pub fn is_remote_authority(&self, authority: &str) -> bool

Check if an authority is remote compared to the authority field of the UUri. Empty authorities are considered to be local.

Returns

‘true’ if authority is a different than Self.authority_name, false otherwise.

Examples

use std::str::FromStr;
use up_rust::UUri;

let authority_a = UUri::from_str("up://authority.a/100A/1/0").unwrap();
let authority_b = "authority.b";
assert!(authority_a.is_remote_authority(&authority_b));

let authority_local = "";
assert!(!authority_a.is_remote_authority(&authority_local));

let authority_wildcard = "*";
assert!(!authority_a.is_remote_authority(&authority_wildcard));

pub fn has_empty_authority(&self) -> bool

Checks if this UUri has an empty authority name.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("", 0x9b3a, 0x01, 0x145b).unwrap();
assert!(uuri.has_empty_authority());

pub fn has_wildcard_authority(&self) -> bool

Checks if this UUri has a wildcard authority name.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("*", 0x9b3a, 0x01, 0x145b).unwrap();
assert!(uuri.has_wildcard_authority());

pub fn has_wildcard_entity_instance(&self) -> bool

Checks if this UUri has an entity identifier matching any instance.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin", 0xFFFF_0123, 0x01, 0x145b).unwrap();
assert!(uuri.has_wildcard_entity_instance());

pub fn has_wildcard_entity_type(&self) -> bool

Checks if this UUri has an entity identifier matching any type.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin", 0x00C0_FFFF, 0x01, 0x145b).unwrap();
assert!(uuri.has_wildcard_entity_type());

pub fn has_wildcard_version(&self) -> bool

Checks if this UUri has a wildcard major version.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin", 0x9b3a, 0xFF, 0x145b).unwrap();
assert!(uuri.has_wildcard_version());

pub fn has_wildcard_resource_id(&self) -> bool

Checks if this UUri has a wildcard entity identifier.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin", 0x9b3a, 0x01, 0xFFFF).unwrap();
assert!(uuri.has_wildcard_resource_id());

pub fn verify_no_wildcards(&self) -> Result<(), UUriError>

Verifies that this UUri does not contain any wildcards.

Errors

Returns an error if any of this UUri’s properties contain a wildcard value.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("vin.vehicles", 0x0000_2310, 0x03, 0xa000).unwrap();
assert!(uri.verify_no_wildcards().is_ok());

pub fn is_rpc_method(&self) -> bool

Checks if this UUri refers to a service method.

Returns true if 0 < resource ID < 0x8000.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x7FFF).unwrap();
assert!(uri.is_rpc_method());

pub fn verify_rpc_method(&self) -> Result<(), UUriError>

Verifies that this UUri refers to a service method.

Errors

Returns an error if Self::is_rpc_method fails or the UUri contains any wildcards.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x8000).unwrap();
assert!(uri.verify_rpc_method().is_err());

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x0000).unwrap();
assert!(uri.verify_rpc_method().is_err());

pub fn is_notification_destination(&self) -> bool

Checks if this UUri represents a destination for a Notification.

Returns true if resource ID is 0.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x0000).unwrap();
assert!(uri.is_notification_destination());

pub fn is_rpc_response(&self) -> bool

Checks if this UUri represents an RPC response address.

Returns true if resource ID is 0.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x0000).unwrap();
assert!(uri.is_rpc_response());

pub fn verify_rpc_response(&self) -> Result<(), UUriError>

Verifies that this UUri represents an RPC response address.

Errors

Returns an error if Self::is_rpc_response fails or the UUri contains any wildcards.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x4001).unwrap();
assert!(uri.verify_rpc_response().is_err());

pub fn is_event(&self) -> bool

Checks if this UUri can be used as the source of an event.

Returns true if resource ID >= 0x8000.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x8000).unwrap();
assert!(uri.is_event());

pub fn verify_event(&self) -> Result<(), UUriError>

Verifies that this UUri can be used as the source of an event.

Errors

Returns an error if Self::is_event fails or the UUri contains any wildcards.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0xabcd, 0x01, 0x7FFF).unwrap();
assert!(uri.verify_event().is_err());

pub fn matches(&self, candidate: &UUri) -> bool

Checks if a given candidate URI matches a pattern.

Returns

true if the candiadate matches the pattern represented by this UUri.

Examples

use up_rust::UUri;

let pattern = UUri::try_from("//vin/A14F/3/FFFF").unwrap();
let candidate = UUri::try_from("//vin/A14F/3/B1D4").unwrap();
assert!(pattern.matches(&candidate));

Trait Implementations

impl AsRef<UUri> for ExactUUri

fn as_ref(&self) -> &UUri

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UUri

fn clone(&self) -> UUri

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UUri

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

Formats the value using the given formatter.

impl Display for UUri

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

Formats the value using the given formatter.

impl From<&UUri> for StaticUriProvider

fn from(source_uri: &UUri) -> Self

Creates a URI provider from a UUri.

Arguments

• source_uri - The UUri to take the entity’s authority, entity ID and version information from. The UUri’s resource ID is ignored.

Examples

use up_rust::{LocalUriProvider, StaticUriProvider, UUri};

let source_uri = UUri::try_from("//my-vehicle/4210/5/1000").unwrap();
let provider = StaticUriProvider::from(&source_uri);
assert_eq!(provider.get_authority(), "my-vehicle");
assert_eq!(provider.get_source_uri(), source_uri.clone_with_resource_id(0x0000));

impl From<&UUri> for String

fn from(uri: &UUri) -> Self

Serializes a uProtocol URI to a URI string.

Arguments

• uri - The URI to serialize. Note that the given URI is not validated before serialization. In particular, the URI’s version and resource ID length are not checked to be within limits.

Returns

The output of UUri::to_uri without including the uProtocol scheme.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("vin.vehicles", 0x0000_800A, 0x02, 0x0000_1a50).unwrap();
let uri_string = String::from(&uuri);
assert_eq!(uri_string, "//vin.vehicles/800A/2/1A50");

impl From<ExactUUri> for UUri

fn from(value: ExactUUri) -> Self

Converts to this type from the input type.

impl From<UUri> for StaticUriProvider

fn from(value: UUri) -> Self

Converts to this type from the input type.

impl FromStr for UUri

fn from_str(uri: &str) -> Result<Self, Self::Err>

Attempts to parse a String into a UUri.

As part of the parsing, the authority of the URI is getting normalized. This means that all characters are converted to lowercase, no bytes that are in the unreserved character set remain percent-encoded, and all alphabetical characters in percent-encodings are converted to uppercase.

Arguments

• uri - The String to be converted into a UUri.

Returns

A Result containing either the UUri representation of the URI or a SerializationError.

Examples

use std::str::FromStr;
use up_rust::UUri;

let uri = UUri::try_from_parts("vin.vehicles", 0x000A_8000, 0x02, 0x0000_1a50).unwrap();
let uri_from = UUri::from_str("//vin.vehicles/A8000/2/1A50").unwrap();
assert_eq!(uri, uri_from);

type Err = UUriError

The associated error which can be returned from parsing.

impl Hash for UUri

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<&str> for UUri

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

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

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 PartialEq<String> for UUri

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

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

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 PartialEq<str> for UUri

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

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

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 PartialEq for UUri

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

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

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 ProtobufMappable for UUri

fn parse_from_protobuf_bytes(proto: &[u8]) -> Result<Self, SerializationError>

Parses an instance of this type from the given protobuf bytes.

fn parse_from_packed_protobuf_bytes( proto: &[u8], ) -> Result<Self, SerializationError>

Parses an instance of this type from the given packed protobuf bytes.

fn write_to_protobuf_bytes(&self) -> Result<Vec<u8>, SerializationError>

Serializes this instance to protobuf bytes.

fn write_to_packed_protobuf_bytes(&self) -> Result<Vec<u8>, SerializationError>

Serializes this instance to packed protobuf bytes.

impl TryFrom<&UUri> for ExactUUri

type Error = UUriError

The type returned in the event of a conversion error.

fn try_from(value: &UUri) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for UUri

fn try_from(uri: &str) -> Result<Self, Self::Error>

Attempts to serialize a String into a UUri.

Arguments

• uri - The String to be converted into a UUri.

Returns

A Result containing either the UUri representation of the URI or a SerializationError.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0x001A_8000, 0x02, 0x1a50).unwrap();
let uri_from = UUri::try_from("/1A8000/2/1A50").unwrap();
assert_eq!(uri, uri_from);

type Error = UUriError

The type returned in the event of a conversion error.

impl TryFrom<String> for UUri

fn try_from(uri: String) -> Result<Self, Self::Error>

Attempts to serialize a String into a UUri.

Arguments

• uri - The String to be converted into a UUri.

Returns

A Result containing either the UUri representation of the URI or a SerializationError.

Examples

use up_rust::UUri;

let uri = UUri::try_from_parts("", 0x001A_8000, 0x02, 0x1a50).unwrap();
let uri_from = UUri::try_from("/1A8000/2/1A50".to_string()).unwrap();
assert_eq!(uri, uri_from);

type Error = UUriError

The type returned in the event of a conversion error.

impl TryFrom<UUri> for ExactUUri

type Error = UUriError

The type returned in the event of a conversion error.

fn try_from(value: UUri) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for UUri

impl StructuralPartialEq for UUri