Struct hls_m3u8::tags::ExtXMap

pub struct ExtXMap<'a> { /* fields omitted */ }

The ExtXMap tag specifies how to obtain the Media Initialization Section, required to parse the applicable MediaSegments.

It applies to every MediaSegment that appears after it in the playlist until the next ExtXMap tag or until the end of the playlist.

An ExtXMap tag should be supplied for MediaSegments in playlists with the ExtXIFramesOnly tag when the first MediaSegment (i.e., I-frame) in the playlist (or the first segment following an ExtXDiscontinuity tag) does not immediately follow the Media Initialization Section at the beginning of its resource.

If the Media Initialization Section declared by an ExtXMap tag is encrypted with EncryptionMethod::Aes128, the IV attribute of the ExtXKey tag that applies to the ExtXMap is required.

Implementations

impl<'a> ExtXMap<'a>

pub fn uri(&self) -> &Cow<'a, str>

The URI that identifies a resource, that contains the media initialization section.

pub fn set_uri<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

The URI that identifies a resource, that contains the media initialization section.

pub fn range(&self) -> Option<ByteRange>

The range of the media initialization section.

pub fn set_range<VALUE: Into<ByteRange>>(
    &mut self,
    value: Option<VALUE>
) -> &mut Self

The range of the media initialization section.

impl<'a> ExtXMap<'a>

pub fn new<T: Into<Cow<'a, str>>>(uri: T) -> Self

Makes a new ExtXMap tag.

Example

let map = ExtXMap::new("https://prod.mediaspace.com/init.bin");

pub fn with_range<I: Into<Cow<'a, str>>, B: Into<ByteRange>>(
    uri: I,
    range: B
) -> Self

Makes a new ExtXMap tag with the given range.

Example

use hls_m3u8::types::ByteRange;

let map = ExtXMap::with_range("https://prod.mediaspace.com/init.bin", 2..11);

pub fn into_owned(self) -> ExtXMap<'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 ExtXMap<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ExtXMap<'a>

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

Formats the value using the given formatter.

impl<'a> Decryptable<'a> for ExtXMap<'a>

fn keys(&self) -> Vec<&DecryptionKey<'a>>

Returns all keys, associated with the type.

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

Most of the time only a single key is provided, so instead of iterating through all keys, one might as well just get the first key.

fn len(&self) -> usize

Returns the number of keys.

fn is_empty(&self) -> bool

Returns true, if the number of keys is zero.

impl<'a> Display for ExtXMap<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for ExtXMap<'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 ExtXMap<'a>

fn cmp(&self, other: &ExtXMap<'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<ExtXMap<'a>> for ExtXMap<'a>

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

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

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

This method tests for !=.

impl<'a> PartialOrd<ExtXMap<'a>> for ExtXMap<'a>

fn partial_cmp(&self, other: &ExtXMap<'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 ExtXMap<'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> Eq for ExtXMap<'a>

impl<'a> StructuralEq for ExtXMap<'a>

impl<'a> StructuralPartialEq for ExtXMap<'a>