Enum hls_m3u8::types::InitializationVector

#[non_exhaustive]
pub enum InitializationVector {
    Aes128([u8; 16]),
    Number(u128),
    Missing,
}

An initialization vector (IV) is a fixed size input that can be used along with a secret key for data encryption.

The use of an IV prevents repetition in encrypted data, making it more difficult for a hacker using a dictionary attack to find patterns and break a cipher. For example, a sequence might appear twice or more within the body of a message. If there are repeated sequences in encrypted data, an attacker could assume that the corresponding sequences in the message were also identical. The IV prevents the appearance of corresponding duplicate character sequences in the ciphertext.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Aes128

An IV for use with Aes128.

Tuple Fields of Aes128

0: [u8; 16]

Number

An ExtXKey tag with KeyFormat::Identity that does not have an IV field indicates that the MediaSegment::number is to be used as the IV when decrypting a MediaSegment.

Tuple Fields of Number

0: u128

Missing

Signals that an IV is missing.

Implementations

impl InitializationVector

pub fn to_u128(&self) -> Option<u128>

Returns the IV as an u128. None is returned for InitializationVector::Missing.

Example

assert_eq!(
    InitializationVector::Aes128([
        0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78,
        0x90, 0x12
    ])
    .to_u128(),
    Some(0x12345678901234567890123456789012)
);

assert_eq!(InitializationVector::Number(0x10).to_u128(), Some(0x10));

assert_eq!(InitializationVector::Missing.to_u128(), None);

pub fn to_slice(&self) -> Option<[u8; 16]>

Returns the IV as a slice, which can be used to for example decrypt a MediaSegment. None is returned for InitializationVector::Missing.

Example

assert_eq!(
    InitializationVector::Aes128([
        0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
        0x0F, 0x10,
    ])
    .to_slice(),
    Some([
        0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
        0x0F, 0x10,
    ])
);

assert_eq!(
    InitializationVector::Number(0x12345678901234567890123456789012).to_slice(),
    Some([
        0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78,
        0x90, 0x12
    ])
);

assert_eq!(InitializationVector::Missing.to_slice(), None);

pub fn is_some(&self) -> bool

Returns true if the initialization vector is not missing.

Example

assert_eq!(
    InitializationVector::Aes128([
        0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
        0x0F, 0x10,
    ])
    .is_some(),
    true
);

assert_eq!(InitializationVector::Number(4).is_some(), true);

assert_eq!(InitializationVector::Missing.is_some(), false);

pub fn is_none(&self) -> bool

Returns true if the initialization vector is missing.

Example

assert_eq!(
    InitializationVector::Aes128([
        0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
        0x0F, 0x10,
    ])
    .is_none(),
    false
);

assert_eq!(InitializationVector::Number(4).is_none(), false);

assert_eq!(InitializationVector::Missing.is_none(), true);

Trait Implementations

impl Clone for InitializationVector

fn clone(&self) -> InitializationVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InitializationVector

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

Formats the value using the given formatter.

impl Default for InitializationVector

fn default() -> Self

Returns the “default value” for a type.

impl Display for InitializationVector

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

Formats the value using the given formatter.

impl From<[u8; 16]> for InitializationVector

fn from(value: [u8; 16]) -> Self

Performs the conversion.

impl From<Option<[u8; 16]>> for InitializationVector

fn from(value: Option<[u8; 16]>) -> Self

Performs the conversion.

impl FromStr for InitializationVector

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for InitializationVector

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 Ord for InitializationVector

fn cmp(&self, other: &InitializationVector) -> 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 PartialEq<InitializationVector> for InitializationVector

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

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

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

This method tests for !=.

impl PartialOrd<InitializationVector> for InitializationVector

fn partial_cmp(&self, other: &InitializationVector) -> 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 Copy for InitializationVector

impl Eq for InitializationVector

impl StructuralEq for InitializationVector

impl StructuralPartialEq for InitializationVector