Struct rustube::id::Id

pub struct Id<'a>(_);

A wrapper around a Cow<'a, str> that makes sure the video id, which is contained, always has the correct format.

Guaranties:

Since YouTube does not guarantee a consistent video-id format, these guarantees can change in major version updates. If your application depends on them, make sure to check this section on regular bases!

• The id will always match following regex (defined in ID_PATTERN): ^[a-zA-Z0-9_-]{11}$
• The id can always be used as a valid url segment
• The id can always be used as a valid url parameter

Ownership

All available constructors except for Id::deserialize and Id::from_string will create the borrowed version with the lifetime of the input. Therefore no allocation is required.

If you don't need 'static deserialization, you can use Id::deserialize_borrowed, which will create an Id<'de>.

If you require Id to be owned (Id<'static>), you can use Id::as_owned or Id::into_owned, which both can easily be chained. You can also use IdBuf, which is an alias for Id<'static>, to make functions and types less verbose.

Implementations

impl<'a> Id<'a>

pub fn from_raw(raw: &'a str) -> Result<Self>

pub fn from_str(id: &'a str) -> Result<Self>

pub fn is_borrowed(&self) -> bool

pub fn is_owned(&self) -> bool

pub fn make_owned(&mut self) -> &mut Self

pub fn into_owned(self) -> IdBuf

pub fn as_owned(&self) -> IdBuf

pub fn as_static(&'a self) -> &'a IdBuf

Creates an &IdBuf from an arbitrary Id.

By just returning a reference, &IdBuf cannot outlive Id, even if the original string might still live:

let string = String::from("12345678910");
// create a borrowed Id bound to the live time of string 
let id: Id = Id::from_raw(&string).unwrap();
// create a reference to an IdBuf bound to the lifetime of id
let id_static: &Id<'static> = id.as_static();
// give ownership of id away | this **must** also invalidate id_static
let id_buf = id.into_owned();
// trying to access id_static now, throws a compile time error
let str_static = id_static.as_str();

pub fn as_borrowed(&'a self) -> Self

pub fn as_str(&self) -> &str

pub fn watch_url(&self) -> Url

pub fn embed_url(&self) -> Url

pub fn share_url(&self) -> Url

impl Id<'static>

pub fn from_string(id: String) -> Result<Self, String>

impl<'de> Id<'de>

pub fn deserialize_borrowed<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Trait Implementations

impl AsRef<str> for Id<'_>

pub fn as_ref(&self) -> &str

Performs the conversion.

impl<'a> Clone for Id<'a>

pub fn clone(&self) -> Id<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Id<'a>

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

Formats the value using the given formatter.

impl Deref for Id<'_>

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for Id<'static>

pub fn deserialize<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Id<'_>

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

Formats the value using the given formatter.

impl Eq for Id<'_>

impl<'a> Hash for Id<'a>

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Id<'_>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T> PartialEq<T> for Id<'_> where
    T: AsRef<str>, 

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> PartialOrd<T> for Id<'_> where
    T: AsRef<str>, 

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

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

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

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

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

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

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

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

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

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

impl<'a> Serialize for Id<'a>

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.