#[repr(transparent)]pub struct Uuid(_);
Expand description
A Universally Unique Identifier (UUID).
Implementations
sourceimpl Uuid
impl Uuid
sourcepub const fn nil() -> Self
pub const fn nil() -> Self
The ‘nil UUID’.
The nil UUID is special form of UUID that is specified to have all 128 bits set to zero, as defined in IETF RFC 4122 Section 4.1.7.
Examples
Basic usage:
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(
uuid.to_hyphenated().to_string(),
"00000000-0000-0000-0000-000000000000"
);
sourcepub fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8]) -> Result<Uuid, Error>
pub fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8]) -> Result<Uuid, Error>
Creates a UUID from four field values in big-endian order.
Errors
This function will return an error if d4
’s length is not 8 bytes.
Examples
Basic usage:
use uuid::Uuid;
let d4 = [12, 3, 9, 56, 54, 43, 8, 9];
let uuid = Uuid::from_fields(42, 12, 5, &d4);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());
let expected_uuid =
Ok(String::from("0000002a-000c-0005-0c03-0938362b0809"));
assert_eq!(expected_uuid, uuid);
sourcepub fn from_fields_le(
d1: u32,
d2: u16,
d3: u16,
d4: &[u8]
) -> Result<Uuid, Error>
pub fn from_fields_le(
d1: u32,
d2: u16,
d3: u16,
d4: &[u8]
) -> Result<Uuid, Error>
Creates a UUID from four field values in little-endian order.
The bytes in the d1
, d2
and d3
fields will
be converted into big-endian order.
Examples
use uuid::Uuid;
let d1 = 0xAB3F1097u32;
let d2 = 0x501Eu16;
let d3 = 0xB736u16;
let d4 = [12, 3, 9, 56, 54, 43, 8, 9];
let uuid = Uuid::from_fields_le(d1, d2, d3, &d4);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());
let expected_uuid =
Ok(String::from("97103fab-1e50-36b7-0c03-0938362b0809"));
assert_eq!(expected_uuid, uuid);
sourcepub const fn from_u128(v: u128) -> Self
pub const fn from_u128(v: u128) -> Self
Creates a UUID from a 128bit value in big-endian order.
sourcepub const fn from_u128_le(v: u128) -> Self
pub const fn from_u128_le(v: u128) -> Self
Creates a UUID from a 128bit value in little-endian order.
sourcepub fn from_slice(b: &[u8]) -> Result<Uuid, Error>
pub fn from_slice(b: &[u8]) -> Result<Uuid, Error>
Creates a UUID using the supplied big-endian bytes.
Errors
This function will return an error if b
has any length other than 16.
Examples
Basic usage:
use uuid::Uuid;
let bytes = [4, 54, 67, 12, 43, 2, 98, 76, 32, 50, 87, 5, 1, 33, 43, 87];
let uuid = Uuid::from_slice(&bytes);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());
let expected_uuid =
Ok(String::from("0436430c-2b02-624c-2032-570501212b57"));
assert_eq!(expected_uuid, uuid);
An incorrect number of bytes:
use uuid::Uuid;
let bytes = [4, 54, 67, 12, 43, 2, 98, 76];
let uuid = Uuid::from_slice(&bytes);
assert!(uuid.is_err());
sourcepub const fn from_bytes(bytes: Bytes) -> Uuid
pub const fn from_bytes(bytes: Bytes) -> Uuid
Creates a UUID using the supplied big-endian bytes.
sourceimpl Uuid
impl Uuid
sourcepub const fn to_hyphenated(self) -> Hyphenated
pub const fn to_hyphenated(self) -> Hyphenated
Get a Hyphenated
formatter.
sourcepub const fn to_hyphenated_ref(&self) -> HyphenatedRef<'_>
pub const fn to_hyphenated_ref(&self) -> HyphenatedRef<'_>
Get a borrowed HyphenatedRef
formatter.
sourcepub const fn to_simple_ref(&self) -> SimpleRef<'_>
pub const fn to_simple_ref(&self) -> SimpleRef<'_>
Get a borrowed SimpleRef
formatter.
sourcepub const fn to_urn_ref(&self) -> UrnRef<'_>
pub const fn to_urn_ref(&self) -> UrnRef<'_>
Get a borrowed UrnRef
formatter.
sourceimpl Uuid
impl Uuid
sourcepub fn new_v4() -> Uuid
pub fn new_v4() -> Uuid
Creates a random UUID.
This uses the getrandom
crate to utilise the operating system’s RNG
as the source of random numbers. If you’d like to use a custom
generator, don’t use this method: generate random bytes using your
custom generator and pass them to the
uuid::Builder::from_bytes
function instead.
Note that usage of this method requires the v4
feature of this crate
to be enabled.
Examples
Basic usage:
use uuid::Uuid;
let uuid = Uuid::new_v4();
sourceimpl Uuid
impl Uuid
sourcepub const NAMESPACE_DNS: Self
pub const NAMESPACE_DNS: Self
UUID namespace for Domain Name System (DNS).
sourcepub const NAMESPACE_OID: Self
pub const NAMESPACE_OID: Self
UUID namespace for ISO Object Identifiers (OIDs).
sourcepub const NAMESPACE_URL: Self
pub const NAMESPACE_URL: Self
UUID namespace for Uniform Resource Locators (URLs).
sourcepub const NAMESPACE_X500: Self
pub const NAMESPACE_X500: Self
UUID namespace for X.500 Distinguished Names (DNs).
sourcepub fn get_variant(&self) -> Option<Variant>
pub fn get_variant(&self) -> Option<Variant>
Returns the variant of the UUID structure.
This determines the interpretation of the structure of the UUID. Currently only the RFC4122 variant is generated by this module.
sourcepub const fn get_version_num(&self) -> usize
pub const fn get_version_num(&self) -> usize
Returns the version number of the UUID.
This represents the algorithm used to generate the contents.
Currently only the Random (V4) algorithm is supported by this module. There are security and privacy implications for using older versions - see Wikipedia: Universally Unique Identifier for details.
sourcepub fn get_version(&self) -> Option<Version>
pub fn get_version(&self) -> Option<Version>
Returns the version of the UUID.
This represents the algorithm used to generate the contents
sourcepub fn as_fields(&self) -> (u32, u16, u16, &[u8; 8])
pub fn as_fields(&self) -> (u32, u16, u16, &[u8; 8])
Returns the four field values of the UUID in big-endian order.
These values can be passed to the from_fields()
method to get the
original Uuid
back.
- The first field value represents the first group of (eight) hex
digits, taken as a big-endian
u32
value. For V1 UUIDs, this field represents the low 32 bits of the timestamp. - The second field value represents the second group of (four) hex
digits, taken as a big-endian
u16
value. For V1 UUIDs, this field represents the middle 16 bits of the timestamp. - The third field value represents the third group of (four) hex digits,
taken as a big-endian
u16
value. The 4 most significant bits give the UUID version, and for V1 UUIDs, the last 12 bits represent the high 12 bits of the timestamp. - The last field value represents the last two groups of four and twelve hex digits, taken in order. The first 1-3 bits of this indicate the UUID variant, and for V1 UUIDs, the next 13-15 bits indicate the clock sequence and the last 48 bits indicate the node ID.
Examples
use uuid::Uuid;
fn main() -> Result<(), uuid::Error> {
let uuid = Uuid::nil();
assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));
let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
assert_eq!(
uuid.as_fields(),
(
0x936DA01F,
0x9ABD,
0x4D9D,
b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
)
);
Ok(())
}
sourcepub fn to_fields_le(&self) -> (u32, u16, u16, &[u8; 8])
pub fn to_fields_le(&self) -> (u32, u16, u16, &[u8; 8])
Returns the four field values of the UUID in little-endian order.
The bytes in the returned integer fields will be converted from big-endian order.
Examples
use uuid::Uuid;
fn main() -> Result<(), uuid::Error> {
let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
assert_eq!(
uuid.to_fields_le(),
(
0x1FA06D93,
0xBD9A,
0x9D4D,
b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
)
);
Ok(())
}
sourcepub fn as_u128(&self) -> u128
pub fn as_u128(&self) -> u128
Returns a 128bit value containing the UUID data.
The bytes in the UUID will be packed into a u128
, like the
Uuid::as_bytes
method.
Examples
use uuid::Uuid;
fn main() -> Result<(), uuid::Error> {
let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
assert_eq!(
uuid.as_u128(),
0x936DA01F9ABD4D9D80C702AF85C822A8,
);
Ok(())
}
sourcepub fn to_u128_le(&self) -> u128
pub fn to_u128_le(&self) -> u128
Returns a 128bit little-endian value containing the UUID data.
The bytes in the UUID will be reversed and packed into a u128
.
Note that this will produce a different result than
Uuid::to_fields_le
, because the entire UUID is reversed, rather
than reversing the individual fields in-place.
Examples
use uuid::Uuid;
fn main() -> Result<(), uuid::Error> {
let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
assert_eq!(
uuid.to_u128_le(),
0xA822C885AF02C7809D4DBD9A1FA06D93,
);
Ok(())
}
sourcepub const fn encode_buffer() -> [u8; 45]
pub const fn encode_buffer() -> [u8; 45]
A buffer that can be used for encode_...
calls, that is
guaranteed to be long enough for any of the adapters.
Examples
use uuid::Uuid;
let uuid = Uuid::nil();
assert_eq!(
uuid.to_simple().encode_lower(&mut Uuid::encode_buffer()),
"00000000000000000000000000000000"
);
assert_eq!(
uuid.to_hyphenated()
.encode_lower(&mut Uuid::encode_buffer()),
"00000000-0000-0000-0000-000000000000"
);
assert_eq!(
uuid.to_urn().encode_lower(&mut Uuid::encode_buffer()),
"urn:uuid:00000000-0000-0000-0000-000000000000"
);
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Uuid
impl<'de> Deserialize<'de> for Uuid
sourcefn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more
sourceimpl<'a> From<&'a Uuid> for HyphenatedRef<'a>
impl<'a> From<&'a Uuid> for HyphenatedRef<'a>
sourceimpl Ord for Uuid
impl Ord for Uuid
sourceimpl PartialOrd<Uuid> for Uuid
impl PartialOrd<Uuid> for Uuid
sourcefn partial_cmp(&self, other: &Uuid) -> Option<Ordering>
fn partial_cmp(&self, other: &Uuid) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Uuid
impl Eq for Uuid
impl StructuralEq for Uuid
impl StructuralPartialEq for Uuid
Auto Trait Implementations
impl RefUnwindSafe for Uuid
impl Send for Uuid
impl Sync for Uuid
impl Unpin for Uuid
impl UnwindSafe for Uuid
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more