Struct uuid::Uuid
[−]
[src]
pub struct Uuid { // some fields omitted }
A Universally Unique Identifier (UUID)
Methods
impl Uuid
[src]
UUID support
fn nil() -> Uuid
Returns a nil or empty UUID (containing all zeroes)
fn new(v: UuidVersion) -> Option<Uuid>
Create a new UUID of the specified version
fn new_v4() -> Uuid
Creates a new random UUID
Uses the rand
module's default RNG task as the source
of random numbers. Use the rand::Rand trait to supply
a custom generator if required.
fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8]) -> Uuid
Creates a UUID using the supplied field values
Arguments
d1
A 32-bit wordd2
A 16-bit wordd3
A 16-bit wordd4
Array of 8 octets
fn from_bytes(b: &[u8]) -> Option<Uuid>
fn get_variant(&self) -> Option<UuidVariant>
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.
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.
fn get_version(&self) -> Option<UuidVersion>
Returns the version of the UUID
This represents the algorithm used to generate the contents
fn as_bytes<'a>(&'a self) -> &'a [u8]
Return an array of 16 octets containing the UUID data
fn to_simple_string(&self) -> String
Returns the UUID as a string of 16 hexadecimal digits
Example: 936DA01F9ABD4d9d80C702AF85C822A8
fn to_hyphenated_string(&self) -> String
Returns a string of hexadecimal digits, separated into groups with a hyphen.
Example: 550e8400-e29b-41d4-a716-446655440000
fn to_urn_string(&self) -> String
Returns the UUID formatted as a full URN string
This is the same as the hyphenated format, but with the "urn:uuid:" prefix.
Example: urn:uuid:F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4
fn parse_str(us: &str) -> Result<Uuid, ParseError>
Parses a UUID from a string of hexadecimal digits with optional hyphens
Any of the formats generated by this module (simple, hyphenated, urn) are supported by this parsing function.
fn is_nil(&self) -> bool
Tests if the UUID is nil
Trait Implementations
impl Clone for Uuid
[src]
fn clone(&self) -> Uuid
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Copy for Uuid
[src]
impl Debug for Uuid
[src]
impl Hash for Uuid
[src]
fn hash<S: Hasher>(&self, state: &mut S)
Feeds this value into the state given, updating the hasher as necessary.
fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher
1.3.0
Feeds a slice of this type into the state provided.
impl Default for Uuid
[src]
impl FromStr for Uuid
[src]
type Err = ParseError
The associated error which can be returned from parsing.
fn from_str(us: &str) -> Result<Uuid, ParseError>
Parse a hex string and interpret as a UUID
Accepted formats are a sequence of 32 hexadecimal characters, with or without hyphens (grouped as 8, 4, 4, 4, 12).
impl Display for Uuid
[src]
Convert the UUID to a hexadecimal-based string representation
impl PartialEq for Uuid
[src]
Test two UUIDs for equality
UUIDs are equal only when they are byte-for-byte identical
fn eq(&self, other: &Uuid) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.
impl Eq for Uuid
[src]
impl Encodable for Uuid
[src]
fn encode<E: Encoder>(&self, e: &mut E) -> Result<(), E::Error>
Encode a UUID as a hyphenated string
impl Decodable for Uuid
[src]
impl Rand for Uuid
[src]
Generates a random instance of UUID (V4 conformant)