Struct hls_m3u8::tags::ExtXKey

pub struct ExtXKey<'a>(pub Option<DecryptionKey<'a>>);

Specifies how to decrypt encrypted data from the server.

An unencrypted segment should be marked with ExtXKey::empty.

Tuple Fields

0: Option<DecryptionKey<'a>>

Implementations

impl<'a> ExtXKey<'a>

pub const fn new(inner: DecryptionKey<'a>) -> Self

Constructs an ExtXKey tag.

Example

use hls_m3u8::types::{DecryptionKey, EncryptionMethod, KeyFormat};

let key = ExtXKey::new(
    DecryptionKey::builder()
        .method(EncryptionMethod::Aes128)
        .uri("https://www.example.com/")
        .iv([
            16, 239, 143, 117, 140, 165, 85, 17, 85, 132, 187, 91, 60, 104, 127, 82,
        ])
        .format(KeyFormat::Identity)
        .versions(vec![1, 2, 3, 4, 5])
        .build()?,
);

pub const fn empty() -> Self

Constructs an empty ExtXKey, which signals that a segment is unencrypted.

Example

assert_eq!(ExtXKey::empty(), ExtXKey(None));

pub fn is_some(&self) -> bool

Returns true if the key is not empty.

Example

use hls_m3u8::types::{DecryptionKey, EncryptionMethod};

let k = ExtXKey::new(DecryptionKey::new(
    EncryptionMethod::Aes128,
    "https://www.example.url",
));
assert_eq!(k.is_some(), true);

let k = ExtXKey::empty();
assert_eq!(k.is_some(), false);

pub fn is_none(&self) -> bool

Returns true if the key is empty.

Example

use hls_m3u8::types::{DecryptionKey, EncryptionMethod};

let k = ExtXKey::new(DecryptionKey::new(
    EncryptionMethod::Aes128,
    "https://www.example.url",
));
assert_eq!(k.is_none(), false);

let k = ExtXKey::empty();
assert_eq!(k.is_none(), true);

pub fn unwrap(self) -> DecryptionKey<'a>

Returns the underlying DecryptionKey, if there is one.

Panics

Panics if there is no underlying decryption key.

Examples

use hls_m3u8::types::{DecryptionKey, EncryptionMethod};

let k = ExtXKey::new(DecryptionKey::new(
    EncryptionMethod::Aes128,
    "https://www.example.url",
));

assert_eq!(
    k.unwrap(),
    DecryptionKey::new(EncryptionMethod::Aes128, "https://www.example.url")
);

use hls_m3u8::types::DecryptionKey;

let decryption_key: DecryptionKey = ExtXKey::empty().unwrap(); // panics

pub fn as_ref(&self) -> Option<&DecryptionKey<'a>>

Returns a reference to the underlying DecryptionKey.

pub fn into_option(self) -> Option<DecryptionKey<'a>>

Converts an ExtXKey into an Option<DecryptionKey>.

Example

use hls_m3u8::types::{DecryptionKey, EncryptionMethod};

assert_eq!(ExtXKey::empty().into_option(), None);

assert_eq!(
    ExtXKey::new(DecryptionKey::new(
        EncryptionMethod::Aes128,
        "https://www.example.url"
    ))
    .into_option(),
    Some(DecryptionKey::new(
        EncryptionMethod::Aes128,
        "https://www.example.url"
    ))
);

pub fn into_owned(self) -> ExtXKey<'static>

Makes the struct independent of its lifetime, by taking ownership of all internal Cows.

Note

This is a relatively expensive operation.

Trait Implementations

impl<'a> Clone for ExtXKey<'a>

fn clone(&self) -> ExtXKey<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ExtXKey<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ExtXKey<'a>

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

Formats the value using the given formatter.

impl<'a> From<DecryptionKey<'a>> for ExtXKey<'a>

fn from(value: DecryptionKey<'a>) -> Self

Performs the conversion.

impl<'a> From<ExtXSessionKey<'a>> for ExtXKey<'a>

fn from(value: ExtXSessionKey<'a>) -> Self

Performs the conversion.

impl<'a> From<Option<DecryptionKey<'a>>> for ExtXKey<'a>

fn from(value: Option<DecryptionKey<'a>>) -> Self

Performs the conversion.

impl<'a> Hash for ExtXKey<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ExtXKey<'a>

fn cmp(&self, other: &ExtXKey<'a>) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<ExtXKey<'a>> for ExtXKey<'a>

fn eq(&self, other: &ExtXKey<'a>) -> bool

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

fn ne(&self, other: &ExtXKey<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<ExtXKey<'a>> for ExtXKey<'a>

fn partial_cmp(&self, other: &ExtXKey<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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> TryFrom<&'a str> for ExtXKey<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(input: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<ExtXKey<'a>> for ExtXSessionKey<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: ExtXKey<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for ExtXKey<'a>

impl<'a> StructuralEq for ExtXKey<'a>

impl<'a> StructuralPartialEq for ExtXKey<'a>