Struct rocket_contrib::uuid::Uuid

pub struct Uuid(_);

Implements FromParam and FromFormValue for accepting UUID values.

Usage

To use, add the uuid feature to the rocket_contrib dependencies section of your Cargo.toml:

[dependencies.rocket_contrib]
version = "*"
default-features = false
features = ["uuid"]

You can use the Uuid type directly as a target of a dynamic parameter:

use rocket_contrib::uuid::Uuid;

#[get("/users/<id>")]
fn user(id: Uuid) -> String {
    format!("We found: {}", id)
}

You can also use the Uuid as a form value, including in query strings:

use rocket_contrib::uuid::Uuid;

#[get("/user?<id>")]
fn user(id: Uuid) -> String {
    format!("User ID: {}", id)
}

Methods

impl Uuid

pub fn into_inner(self) -> Uuid

Consumes the Uuid wrapper, returning the underlying Uuid type.

Example

use rocket_contrib::uuid::{uuid_crate, Uuid};

let uuid_str = "c1aa1e3b-9614-4895-9ebd-705255fa5bc2";
let real_uuid = uuid_crate::Uuid::from_str(uuid_str).unwrap();
let my_inner_uuid = Uuid::from_str(uuid_str)
    .expect("valid UUID string")
    .into_inner();

assert_eq!(real_uuid, my_inner_uuid);

Methods from Deref<Target = Uuid>

pub fn to_hyphenated_ref(&self) -> HyphenatedRef

Creates a HyphenatedRef instance from a Uuid reference.

pub fn to_simple_ref(&self) -> SimpleRef

Creates a SimpleRef instance from a Uuid reference.

pub fn to_urn_ref(&self) -> UrnRef

Creates a UrnRef instance from a Uuid reference.

pub const NAMESPACE_DNS: Uuid

pub const NAMESPACE_OID: Uuid

pub const NAMESPACE_URL: Uuid

pub const NAMESPACE_X500: Uuid

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.

• Variant Reference

pub 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.

• Version Reference

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

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

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;

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

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;

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

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

Returns an array of 16 octets containing the UUID data. This method wraps [Uuid::as_bytes]

pub fn to_timestamp(&self) -> Option<(u64, u16)>

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

pub fn is_nil(&self) -> bool

Tests if the UUID is nil

Trait Implementations

impl Eq for Uuid

impl Clone for Uuid

fn clone(&self) -> Uuid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Uuid

impl PartialOrd<Uuid> for Uuid

fn partial_cmp(&self, other: &Uuid) -> Option<Ordering>

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

fn lt(&self, other: &Uuid) -> bool

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

fn le(&self, other: &Uuid) -> bool

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

fn gt(&self, other: &Uuid) -> bool

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

fn ge(&self, other: &Uuid) -> bool

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

impl PartialEq<Uuid> for Uuid

fn eq(&self, other: &Uuid) -> bool

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

fn ne(&self, other: &Uuid) -> bool

This method tests for !=.

impl PartialEq<Uuid> for Uuid

fn eq(&self, other: &Uuid) -> bool

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

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for Uuid

fn cmp(&self, other: &Uuid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Deref for Uuid

type Target = Uuid

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Debug for Uuid

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

Formats the value using the given formatter.

impl Display for Uuid

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

Formats the value using the given formatter.

impl FromStr for Uuid

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl<'a> FromParam<'a> for Uuid

type Error = ParseError

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

fn from_param(param: &'a RawStr) -> Result<Uuid, Self::Error>

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

impl<'v> FromFormValue<'v> for Uuid

type Error = &'v RawStr

The associated error which can be returned from parsing. It is a good idea to have the return type be or contain an &'v str so that the unparseable string can be examined after a bad parse.

fn from_form_value(form_value: &'v RawStr) -> Result<Uuid, &'v RawStr>

A value is successfully parsed if form_value is a properly formatted Uuid. Otherwise, the raw form value is returned.

fn default() -> Option<Self>

Returns a default value to be used when the form field does not exist. If this returns None, then the field is required. Otherwise, this should return Some(default_value). The default implementation simply returns None.