Struct rocket::serde::uuid::Uuid[][src]

#[repr(transparent)]
pub struct Uuid(_);
This is supported on crate feature uuid only.
Expand description

A Universally Unique Identifier (UUID).

Examples

To parse a UUID and print it as a urn:

use rocket::serde::uuid::{Uuid, Error};

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
println!("{}", uuid.to_urn());

A Universally Unique Identifier (UUID).

Implementations

impl Uuid[src]

A Universally Unique Identifier (UUID).

Examples

To parse a UUID and print it as a urn:

use rocket::serde::uuid::{Uuid, Error};

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
println!("{}", uuid.to_urn());

pub const fn nil() -> Uuid[src]

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

pub fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8]) -> Result<Uuid, Error>[src]

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

pub fn from_fields_le(
    d1: u32,
    d2: u16,
    d3: u16,
    d4: &[u8]
) -> Result<Uuid, Error>
[src]

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

pub const fn from_u128(v: u128) -> Uuid[src]

Creates a UUID from a 128bit value in big-endian order.

pub const fn from_u128_le(v: u128) -> Uuid[src]

Creates a UUID from a 128bit value in little-endian order.

pub fn from_slice(b: &[u8]) -> Result<Uuid, Error>[src]

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

pub const fn from_bytes(bytes: [u8; 16]) -> Uuid[src]

Creates a UUID using the supplied big-endian bytes.

impl Uuid[src]

A Universally Unique Identifier (UUID).

Examples

To parse a UUID and print it as a urn:

use rocket::serde::uuid::{Uuid, Error};

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
println!("{}", uuid.to_urn());

pub fn parse_str(input: &str) -> Result<Uuid, Error>[src]

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.

impl Uuid[src]

A Universally Unique Identifier (UUID).

Examples

To parse a UUID and print it as a urn:

use rocket::serde::uuid::{Uuid, Error};

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
println!("{}", uuid.to_urn());

pub const fn to_hyphenated(self) -> Hyphenated[src]

Get a Hyphenated formatter.

pub const fn to_hyphenated_ref(&self) -> HyphenatedRef<'_>[src]

Get a borrowed HyphenatedRef formatter.

pub const fn to_simple(self) -> Simple[src]

Get a Simple formatter.

pub const fn to_simple_ref(&self) -> SimpleRef<'_>[src]

Get a borrowed SimpleRef formatter.

pub const fn to_urn(self) -> Urn[src]

Get a Urn formatter.

pub const fn to_urn_ref(&self) -> UrnRef<'_>[src]

Get a borrowed UrnRef formatter.

impl Uuid[src]

A Universally Unique Identifier (UUID).

Examples

To parse a UUID and print it as a urn:

use rocket::serde::uuid::{Uuid, Error};

let uuid = Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
println!("{}", uuid.to_urn());

pub const NAMESPACE_DNS: Uuid[src]

UUID namespace for Domain Name System (DNS).

pub const NAMESPACE_OID: Uuid[src]

UUID namespace for ISO Object Identifiers (OIDs).

pub const NAMESPACE_URL: Uuid[src]

UUID namespace for Uniform Resource Locators (URLs).

pub const NAMESPACE_X500: Uuid[src]

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

pub fn get_variant(&self) -> Option<Variant>[src]

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.

pub const fn get_version_num(&self) -> usize[src]

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.

pub fn get_version(&self) -> Option<Version>[src]

Returns the version of the UUID.

This represents the algorithm used to generate the contents

pub fn as_fields(&self) -> (u32, u16, u16, &[u8; 8])[src]

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

pub fn to_fields_le(&self) -> (u32, u16, u16, &[u8; 8])[src]

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

pub fn as_u128(&self) -> u128[src]

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

pub fn to_u128_le(&self) -> u128[src]

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

pub const fn as_bytes(&self) -> &[u8; 16][src]

Returns an array of 16 octets containing the UUID data.

pub fn is_nil(&self) -> bool[src]

Tests if the UUID is nil.

pub const fn encode_buffer() -> [u8; 45][src]

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

impl Clone for Uuid[src]

pub fn clone(&self) -> Uuid[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Uuid[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl Default for Uuid[src]

pub fn default() -> Uuid[src]

Returns the “default value” for a type. Read more

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

pub fn deserialize<D>(
    deserializer: D
) -> Result<Uuid, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 
[src]

Deserialize this value from the given Serde deserializer. Read more

impl Display for Uuid[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

impl<'v> FromFormField<'v> for Uuid[src]

fn from_value(field: ValueField<'v>) -> Result<'v, Self>[src]

Parse a value of T from a form value field. Read more

#[must_use]
fn from_data<'life0, 'async_trait>(
    field: DataField<'v, 'life0>
) -> Pin<Box<dyn Future<Output = Result<'v, Self>> + Send + 'async_trait>> where
    'v: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 
[src]

Parse a value of T from a form data field. Read more

fn default() -> Option<Self>[src]

Returns a default value, if any exists, to be used during lenient parsing when the form field is missing. Read more

impl<'a> FromParam<'a> for Uuid[src]

fn from_param(param: &'a str) -> Result<Uuid, Self::Error>[src]

A value is successfully parsed if param is a properly formatted Uuid. Otherwise, an error is returned.

type Error = Error

The associated error to be returned if parsing/validation fails.

impl FromStr for Uuid[src]

type Err = Error

The associated error which can be returned from parsing.

pub fn from_str(uuid_str: &str) -> Result<Uuid, <Uuid as FromStr>::Err>[src]

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

impl<'x, P> FromUriParam<P, &'x Uuid> for Uuid where
    P: Part

type Target = &'x Uuid

The resulting type of this conversion.

pub fn from_uri_param(param: &'x Uuid) -> &'x Uuid

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation. Read more

impl<'x, P> FromUriParam<P, &'x mut Uuid> for Uuid where
    P: Part

type Target = &'x mut Uuid

The resulting type of this conversion.

pub fn from_uri_param(param: &'x mut Uuid) -> &'x mut Uuid

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation. Read more

impl<P> FromUriParam<P, Uuid> for Uuid where
    P: Part

type Target = Uuid

The resulting type of this conversion.

pub fn from_uri_param(param: Uuid) -> Uuid

Converts a value of type T into a value of type Self::Target. The resulting value of type Self::Target will be rendered into a URI using its UriDisplay implementation. Read more

impl Hash for Uuid[src]

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher
[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

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

impl LowerHex for Uuid[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter.

impl Ord for Uuid[src]

pub fn cmp(&self, other: &Uuid) -> Ordering[src]

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

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl PartialEq<Uuid> for Uuid[src]

pub fn eq(&self, other: &Uuid) -> bool[src]

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

pub fn ne(&self, other: &Uuid) -> bool[src]

This method tests for !=.

impl PartialOrd<Uuid> for Uuid[src]

pub fn partial_cmp(&self, other: &Uuid) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

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

impl Serialize for Uuid[src]

pub fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer
[src]

Serialize this value into the given Serde serializer. Read more

impl UpperHex for Uuid[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter.

impl<P> UriDisplay<P> for Uuid where
    P: Part

This implementation is identical to the Display implementation.

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

Formats self in a URI-safe manner using the given formatter.

impl Copy for Uuid[src]

impl Eq for Uuid[src]

impl StructuralEq for Uuid[src]

impl StructuralPartialEq for Uuid[src]

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized
[src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]