Enum KnownTag 

pub enum KnownTag<'a, Custom = NoCustomTag>
where
    Custom: CustomTag<'a>,
{
    Hls(Tag<'a>),
    Custom(CustomTagAccess<'a, Custom>),
}

Represents a HLS tag that is known to the library.

Known tags are split into two cases, those which are defined by the library, and those that are custom defined by the user. The library makes an effort to reflect in types what is specified via the latest draft-pantos-hls-rfc8216 specification. The HLS specification also allows for unknown tags which are intended to be ignored by clients; however, using that, special custom implementations can be built up. Some notable examples are the #EXT-X-SCTE35 tag defined in SCTE 35 standard (which has been superceded by the SCTE35 attributes on #EXT-X-DATERANGE), the #EXT-X-IMAGE-STREAM-INF tag (and associated tags) defined via Roku Developers, the #EXT-X-PREFETCH tag defined by LHLS, and there are many more. We find that this flexibility is a useful trait of HLS and so aim to support it here. For use cases where there is no need for any custom tag parsing, the NoCustomTag implementation of CustomTag exists, and is the default implementation of the generic Custom parameter in this enum.

Variants

Hls(Tag<'a>)

Indicates that the tag found was one of the 32 known tags defined in the HLS specification that are supported here in this library (and that were not ignored by crate::config::ParsingOptions). See hls::Tag for a more complete documentation of all of the known tag types.

Custom(CustomTagAccess<'a, Custom>)

Indicates that the tag found was one matching the CustomTag definition that the user of the library has defined. The tag is wrapped in a CustomTagAccess struct (see that struct documentation for reasoning on why the wrapping exists) and can be borrowed via the CustomTagAccess::as_ref method or mutably borrowed via the CustomTagAccess::as_mut method. Refer to CustomTag for more information on how to define a custom tag.

Trait Implementations

impl<'a, Custom> Clone for KnownTag<'a, Custom>

where Custom: CustomTag<'a> + Clone,

fn clone(&self) -> KnownTag<'a, Custom>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, Custom> Debug for KnownTag<'a, Custom>

where Custom: CustomTag<'a> + Debug,

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

Formats the value using the given formatter.

impl<'a, Custom> IntoInnerTag<'a> for KnownTag<'a, Custom>

where Custom: WritableCustomTag<'a>,

fn into_inner(self) -> TagInner<'a>

Consume self and provide TagInner.

impl<'a, Custom> PartialEq for KnownTag<'a, Custom>

where Custom: CustomTag<'a> + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, Custom> TryFrom<UnknownTag<'a>> for KnownTag<'a, Custom>

where Custom: CustomTag<'a>,

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(tag: UnknownTag<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, Custom> StructuralPartialEq for KnownTag<'a, Custom>

where Custom: CustomTag<'a>,