Struct UUID

pub struct UUID {
    pub msb: u64,
    pub lsb: u64,
    pub special_fields: SpecialFields,
}

Fields

msb: u64

lsb: u64

special_fields: SpecialFields

Implementations

impl UUID

pub fn build() -> UUID

Creates a new UUID that can be used for uProtocol messages.

Panics

if the system clock is set to an instant before the UNIX Epoch.

Examples

use up_rust::UUID;

let uuid = UUID::build();
assert!(uuid.is_uprotocol_uuid());

pub fn to_hyphenated_string(&self) -> String

Serializes this UUID to a hyphenated string as defined by RFC 4122, Section 3 using lower case characters.

Examples

use up_rust::UUID;

// timestamp = 1, ver = 0b0111
let msb = 0x0000000000017000_u64;
// variant = 0b10, random = 0x0010101010101a1a
let lsb = 0x8010101010101a1a_u64;
let uuid = UUID { msb, lsb, ..Default::default() };
assert_eq!(uuid.to_hyphenated_string(), "00000000-0001-7000-8010-101010101a1a");

pub fn get_time(&self) -> Option<u64>

Returns the point in time that this UUID has been created at.

Returns

The number of milliseconds since UNIX EPOCH if this UUID is a uProtocol UUID, or Option::None otherwise.

Examples

use up_rust::UUID;

// timestamp = 0x018D548EA8E0 (Monday, 29 January 2024, 9:30:52 AM GMT)
// ver = 0b0111
let msb = 0x018D548EA8E07000u64;
// variant = 0b10
let lsb = 0x8000000000000000u64;
let creation_time = UUID { msb, lsb, ..Default::default() }.get_time();
assert_eq!(creation_time.unwrap(), 0x018D548EA8E0_u64);

// timestamp = 1, (invalid) ver = 0b1100
let msb = 0x000000000001C000u64;
// variant = 0b10
let lsb = 0x8000000000000000u64;
let creation_time = UUID { msb, lsb, ..Default::default() }.get_time();
assert!(creation_time.is_none());

pub fn is_uprotocol_uuid(&self) -> bool

Checks if this is a valid uProtocol UUID.

Returns

true if this UUID meets the formal requirements defined by the uProtocol spec.

Examples

use up_rust::UUID;

// timestamp = 1, ver = 0b0111
let msb = 0x0000000000017000u64;
// variant = 0b10
let lsb = 0x8000000000000000u64;
assert!(UUID { msb, lsb, ..Default::default() }.is_uprotocol_uuid());

// timestamp = 1, (invalid) ver = 0b1100
let msb = 0x000000000001C000u64;
// variant = 0b10
let lsb = 0x8000000000000000u64;
assert!(!UUID { msb, lsb, ..Default::default() }.is_uprotocol_uuid());

// timestamp = 1, ver = 0b0111
let msb = 0x0000000000017000u64;
// (invalid) variant = 0b01
let lsb = 0x4000000000000000u64;
assert!(!UUID { msb, lsb, ..Default::default() }.is_uprotocol_uuid());

impl UUID

pub fn new() -> UUID

Trait Implementations

impl Clone for UUID

fn clone(&self) -> UUID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UUID

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

Formats the value using the given formatter.

impl<'a> Default for &'a UUID

fn default() -> &'a UUID

Returns the “default value” for a type.

impl Default for UUID

fn default() -> UUID

Returns the “default value” for a type.

impl Display for UUID

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

Formats the value using the given formatter.

impl From<&UUID> for String

fn from(value: &UUID) -> Self

Converts to this type from the input type.

impl From<UUID> for String

fn from(value: UUID) -> Self

Converts to this type from the input type.

impl FromStr for UUID

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

Parses a string into a UUID.

Returns

a uProtocol UUID based on the bytes encoded in the string.

Errors

Returns an error

• if the given string does not represent a UUID as defined by RFC 4122, Section 3, or
• if the bytes encoded in the string contain an invalid version and/or variant identifier.

Examples

use up_rust::UUID;

// parsing a valid uProtocol UUID succeeds
let parsing_attempt = "00000000-0001-7000-8010-101010101a1A".parse::<UUID>();
assert!(parsing_attempt.is_ok());
let uuid = parsing_attempt.unwrap();
assert!(uuid.is_uprotocol_uuid());
assert_eq!(uuid.msb, 0x0000000000017000_u64);
assert_eq!(uuid.lsb, 0x8010101010101a1a_u64);

// parsing an invalid UUID fails
assert!("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
    .parse::<UUID>()
    .is_err());

// parsing a string that is not a UUID fails
assert!("this-is-not-a-UUID"
    .parse::<UUID>()
    .is_err());

type Err = UuidConversionError

The associated error which can be returned from parsing.

impl Hash for UUID

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 UUID

const NAME: &'static str = "UUID"

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

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static UUID

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 UUID

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for UUID

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

type RuntimeType = RuntimeTypeMessage<UUID>

Actual implementation of type properties.

impl Eq for UUID

impl StructuralPartialEq for UUID