Struct sentry_types::Uuid[][src]

pub struct Uuid(_);

A Universally Unique Identifier (UUID).

Methods

impl Uuid
[src]

Creates a Hyphenated instance from a Uuid.

Creates a HyphenatedRef instance from a Uuid reference.

Creates a Simple instance from a Uuid.

Creates a SimpleRef instance from a Uuid reference.

Creates a Urn instance from a Uuid.

Creates a UrnRef instance from a Uuid reference.

impl Uuid
[src]

Creates a random Uuid.

This uses the rand crate's default task RNG as the source of random numbers. If you'd like to use a custom generator, don't use this method: use the rand::Rand trait's rand() method 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();

impl Uuid
[src]

NAMESPACE_DNS: Uuid = Uuid([107, 167, 184, 16, 157, 173, 17, 209, 128, 180, 0, 192, 79, 212, 48,
      200])

Uuid namespace for Domain Name System (DNS).

NAMESPACE_OID: Uuid = Uuid([107, 167, 184, 18, 157, 173, 17, 209, 128, 180, 0, 192, 79, 212, 48,
      200])

Uuid namespace for ISO Object Identifiers (OIDs).

NAMESPACE_URL: Uuid = Uuid([107, 167, 184, 17, 157, 173, 17, 209, 128, 180, 0, 192, 79, 212, 48,
      200])

Uuid namespace for Uniform Resource Locators (URLs).

NAMESPACE_X500: Uuid = Uuid([107, 167, 184, 20, 157, 173, 17, 209, 128, 180, 0, 192, 79, 212, 48,
      200])

Uuid namespace for X.500 Distinguished Names (DNs).

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"
);

Creates a Uuid from four field values.

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);

An invalid length:

use uuid::prelude::*;

let d4 = [12];

let uuid = uuid::Uuid::from_fields(42, 12, 5, &d4);

let expected_uuid = Err(uuid::BytesError::new(8, d4.len()));

assert_eq!(expected_uuid, uuid);

Creates a Uuid using the supplied 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::prelude::*;

let bytes = [4, 54, 67, 12, 43, 2, 98, 76];

let uuid = Uuid::from_slice(&bytes);

let expected_uuid = Err(uuid::BytesError::new(16, 8));

assert_eq!(expected_uuid, uuid);

Creates a Uuid using the supplied bytes.

Examples

Basic usage:

use uuid::Bytes;
use uuid::Uuid;

let bytes: Bytes = [
    70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90, 145, 63,
    62,
];

let uuid = Uuid::from_bytes(bytes);
let uuid = uuid.to_hyphenated().to_string();

let expected_uuid = String::from("46ebd0ee-0e6d-43c9-b90d-ccc35a913f3e");

assert_eq!(expected_uuid, uuid);

An incorrect number of bytes:

This example deliberately fails to compile
use uuid::Uuid;
use uuid::UuidBytes;

let bytes: UuidBytes = [4, 54, 67, 12, 43, 2, 98, 76]; // doesn't
compile

let uuid = Uuid::from_bytes(bytes);

Creates a v4 Uuid from random bytes (e.g. bytes supplied from Rand crate)

Examples

Basic usage:

use uuid::Bytes;
use uuid::Uuid;

let bytes: Bytes = [
    70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90, 145, 63,
    62,
];
let uuid = Uuid::from_random_bytes(bytes);
let uuid = uuid.to_hyphenated().to_string();

let expected_uuid = String::from("46ebd0ee-0e6d-43c9-b90d-ccc35a913f3e");

assert_eq!(expected_uuid, uuid);

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.

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.

Returns the version of the Uuid.

This represents the algorithm used to generate the contents

Returns the four field values of the UUID.

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;

let uuid = Uuid::nil();
assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));

let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8").unwrap();
assert_eq!(
    uuid.as_fields(),
    (
        0x936DA01F,
        0x9ABD,
        0x4D9D,
        b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
    )
);

Returns an array of 16 octets containing the UUID data.

Examples

use uuid::Uuid;

let uuid = Uuid::nil();
assert_eq!(uuid.as_bytes(), &[0; 16]);

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8").unwrap();
assert_eq!(
    uuid.as_bytes(),
    &[
        147, 109, 160, 31, 154, 189, 77, 157, 128, 199, 2, 175, 133, 200,
        34, 168
    ]
);

Returns an Optional Tuple of (u64, u16) representing the timestamp and counter portion of a V1 UUID. If the supplied UUID is not V1, this will return None

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.

Tests if the UUID is nil

Trait Implementations

impl From<Uuid> for DebugId
[src]

Performs the conversion.

impl LowerHex for Uuid
[src]

Formats the value using the given formatter.

impl PartialOrd<Uuid> for Uuid
[src]

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Hash for Uuid
[src]

Feeds this value into the given [Hasher]. Read more

Feeds a slice of this type into the given [Hasher]. Read more

impl Display for Uuid
[src]

Formats the value using the given formatter. Read more

impl Clone for Uuid
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl Serialize for Uuid
[src]

Serialize this value into the given Serde serializer. Read more

impl FromStr for Uuid
[src]

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

impl Default for Uuid
[src]

Returns the "default value" for a type. Read more

impl<'de> Deserialize<'de> for Uuid
[src]

Deserialize this value from the given Serde deserializer. Read more

impl Debug for Uuid
[src]

Formats the value using the given formatter. Read more

impl Copy for Uuid
[src]

impl Ord for Uuid
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl Eq for Uuid
[src]

impl PartialEq<Uuid> for Uuid
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<'a> From<&'a Uuid> for UrnRef<'a>
[src]

Performs the conversion.

impl<'a> From<&'a Uuid> for HyphenatedRef<'a>
[src]

Performs the conversion.

impl From<Uuid> for Urn
[src]

Performs the conversion.

impl From<Uuid> for Simple
[src]

Performs the conversion.

impl<'a> From<&'a Uuid> for SimpleRef<'a>
[src]

Performs the conversion.

impl From<Uuid> for Hyphenated
[src]

Performs the conversion.

impl UpperHex for Uuid
[src]

Formats the value using the given formatter.

Auto Trait Implementations

impl Send for Uuid

impl Sync for Uuid