Enum EnumeratedString

pub enum EnumeratedString<'a, T> {
    Known(T),
    Unknown(&'a str),
}

Provides a forward compatible wrapper for enumerated string values.

The intent is that all cases of an enumerated string are captured within T; however, in case a new value is added to HLS and this library has not been updated to support it yet, this enum also supports an Unknown case that contains a custom string. In this way, parsing won’t break as new cases are added to the specification.

Note, that as long as T implements Into<Cow<str>>, then EnumeratedString<T> also implements Into<Cow<str>>. This is a convenience for when setting values on known tags. Also note that most library implementations of T will also implement From<T> for EnumeratedString<T>, which is another convenience for all methods that take some impl Into<EnumeratedString<T>>.

Variants

Known(T)

The value is known to the library and provided by T.

Unknown(&'a str)

The value is unknown to the library but a reference to the original data is provided.

Implementations

impl<T> EnumeratedString<'_, T>

pub fn known(&self) -> Option<&T>

A convenience method for getting the known value. This may be most helpful when chaining on an already optional attribute.

impl<'a, T> EnumeratedString<'a, T>

where T: AsStaticCow,

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

Provides the inner data as a std::borrow::Cow.

Trait Implementations

impl<'a, T: Clone> Clone for EnumeratedString<'a, T>

fn clone(&self) -> EnumeratedString<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for EnumeratedString<'a, T>

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

Formats the value using the given formatter.

impl<T> Display for EnumeratedString<'_, T>

where T: Display,

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

Formats the value using the given formatter.

impl<'a, T> From<&'a str> for EnumeratedString<'a, T>

where T: TryFrom<&'a str, Error = UnrecognizedEnumerationError<'a>>,

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<AudioCodingIdentifier> for EnumeratedString<'_, AudioCodingIdentifier>

fn from(value: AudioCodingIdentifier) -> Self

Converts to this type from the input type.

impl From<ChannelSpecialUsageIdentifier> for EnumeratedString<'_, ChannelSpecialUsageIdentifier>

fn from(value: ChannelSpecialUsageIdentifier) -> Self

Converts to this type from the input type.

impl From<Cue> for EnumeratedString<'_, Cue>

fn from(value: Cue) -> Self

Converts to this type from the input type.

impl<'a, T> From<EnumeratedString<'a, T>> for Cow<'a, str>

where T: Into<Cow<'a, str>>,

fn from(value: EnumeratedString<'a, T>) -> Self

Converts to this type from the input type.

impl From<FairPlayCpcLabel> for EnumeratedString<'_, FairPlayCpcLabel>

fn from(value: FairPlayCpcLabel) -> Self

Converts to this type from the input type.

impl From<Format> for EnumeratedString<'_, Format>

fn from(value: Format) -> Self

Converts to this type from the input type.

impl From<HdcpLevel> for EnumeratedString<'_, HdcpLevel>

fn from(value: HdcpLevel) -> Self

Converts to this type from the input type.

impl From<InstreamId> for EnumeratedString<'_, InstreamId>

fn from(value: InstreamId) -> Self

Converts to this type from the input type.

impl From<MediaCharacteristicTag> for EnumeratedString<'_, MediaCharacteristicTag>

fn from(value: MediaCharacteristicTag) -> Self

Converts to this type from the input type.

impl From<MediaType> for EnumeratedString<'_, MediaType>

fn from(value: MediaType) -> Self

Converts to this type from the input type.

impl From<Method> for EnumeratedString<'_, Method>

fn from(value: Method) -> Self

Converts to this type from the input type.

impl From<PreloadHintType> for EnumeratedString<'_, PreloadHintType>

fn from(value: PreloadHintType) -> Self

Converts to this type from the input type.

impl From<VideoChannelSpecifier> for EnumeratedString<'_, VideoChannelSpecifier>

fn from(value: VideoChannelSpecifier) -> Self

Converts to this type from the input type.

impl From<VideoProjectionSpecifier> for EnumeratedString<'_, VideoProjectionSpecifier>

fn from(value: VideoProjectionSpecifier) -> Self

Converts to this type from the input type.

impl From<VideoRange> for EnumeratedString<'_, VideoRange>

fn from(value: VideoRange) -> Self

Converts to this type from the input type.

impl<'a, T: PartialEq> PartialEq for EnumeratedString<'a, T>

fn eq(&self, other: &EnumeratedString<'a, T>) -> 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, T: Copy> Copy for EnumeratedString<'a, T>

impl<'a, T> StructuralPartialEq for EnumeratedString<'a, T>