Struct UUri

pub struct UUri {
    pub authority_name: String,
    pub ue_id: u32,
    pub ue_version_major: u32,
    pub resource_id: u32,
    pub special_fields: SpecialFields,
}

Fields

authority_name: String

ue_id: u32

ue_version_major: u32

resource_id: u32

special_fields: SpecialFields

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 {
    authority_name: String::from("VIN.vehicles"),
    ue_id: 0x0000_800A,
    ue_version_major: 0x02,
    resource_id: 0x0000_1a50,
    ..Default::default()
};

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 URI that consists of wildcards only and therefore matches any URI.

pub fn any_with_resource_id(resource_id: u32) -> Self

Gets a URI that consists of wildcards and the specific resource ID.

pub fn authority_name(&self) -> String

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 check_validity(&self) -> Result<(), UUriError>

Verifies that this UUri is indeed a valid uProtocol URI.

This check is not necessary, if any of UUri’s constructors functions has been used to create the URI. However, if the origin of a UUri is unknown, e.g. when it has been deserialized from a protobuf, then this function can be used to check if all properties are compliant with the uProtocol specification.

Errors

Returns an error if this UUri is not a valid uProtocol URI. The returned error may contain details regarding the cause of the validation to have failed.

Examples

use up_rust::UUri;

let uuri = UUri {
  authority_name: "valid_name".into(),
  ue_id: 0x1000,
  ue_version_major: 0x01,
  resource_id: 0x8100,
  ..Default::default()
};
assert!(uuri.check_validity().is_ok());

pub fn is_empty(&self) -> bool

Checks if this URI is empty.

Returns

‘true’ if this URI is equal to UUri::default(), false otherwise.

Examples

use up_rust::UUri;

let uuri = UUri::try_from_parts("MYVIN", 0xa13b, 0x01, 0x7f4e).unwrap();
assert!(!uuri.is_empty());
assert!(UUri::default().is_empty());

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: &String) -> 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".to_string();
assert!(authority_a.is_remote_authority(&authority_b));

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

let authority_wildcard = "*".to_string();
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 {
    authority_name: String::from("VIN.vehicles"),
    ue_id: 0x0000_2310,
    ue_version_major: 0x03,
    resource_id: 0xa000,
    ..Default::default()
};
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 {
    resource_id: 0x7FFF,
    ..Default::default()
};
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 {
    resource_id: 0x8000,
    ..Default::default()
};
assert!(uri.verify_rpc_method().is_err());

let uri = UUri {
    resource_id: 0x0,
    ..Default::default()
};
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 {
    resource_id: 0,
    ..Default::default()
};
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 {
    resource_id: 0,
    ..Default::default()
};
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 {
    resource_id: 0x4001,
    ..Default::default()
};
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 {
    resource_id: 0x8000,
    ..Default::default()
};
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 {
    resource_id: 0x7FFF,
    ..Default::default()
};
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));

impl UUri

pub fn new() -> UUri

Trait Implementations

impl Clone for UUri

fn clone(&self) -> UUri

Returns a duplicate of the value.

const 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<'a> Default for &'a UUri

fn default() -> &'a UUri

Returns the “default value” for a type.

impl Default for UUri

fn default() -> UUri

Returns the “default value” for a type.

impl Display for UUri

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

Formats the value using the given formatter.

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 {
    authority_name: String::from("VIN.vehicles"),
    ue_id: 0x0000_800A,
    ue_version_major: 0x02,
    resource_id: 0x0000_1a50,
    ..Default::default()
};

let uri_string = String::from(&uuri);
assert_eq!(uri_string, "//VIN.vehicles/800A/2/1A50");

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 {
    authority_name: "VIN.vehicles".to_string(),
    ue_id: 0x000A_8000,
    ue_version_major: 0x02,
    resource_id: 0x0000_1a50,
    ..Default::default()
};

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

const NAME: &'static str = "UUri"

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

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static UUri

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 UUri

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for UUri

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

type RuntimeType = RuntimeTypeMessage<UUri>

Actual implementation of type properties.

impl TryFrom<&UUri> for StaticUriProvider

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

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.

Errors

Returns an error if the given UUri’s major version property is not a u8.

Examples

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

let source_uri = UUri::try_from("//my-vehicle/4210/5/0").unwrap();
assert!(StaticUriProvider::try_from(&source_uri).is_ok());

Invalid Major Version

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

let uuri_with_invalid_version = UUri {
  authority_name: "".to_string(),
  ue_id: 0x5430,
  ue_version_major: 0x1234, // not a u8
  resource_id: 0x0000,
  ..Default::default()
};
assert!(StaticUriProvider::try_from(uuri_with_invalid_version).is_err());

type Error = TryFromIntError

The type returned in the event of a conversion error.

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 {
    authority_name: "".to_string(),
    ue_id: 0x001A_8000,
    ue_version_major: 0x02,
    resource_id: 0x0000_1a50,
    ..Default::default()
};

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 {
    authority_name: "".to_string(),
    ue_id: 0x001A_8000,
    ue_version_major: 0x02,
    resource_id: 0x0000_1a50,
    ..Default::default()
};

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 StaticUriProvider

type Error = TryFromIntError

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