Struct SessionKey 

pub struct SessionKey<'a> { /* private fields */ }

Corresponds to the #EXT-X-SESSION-KEY tag.

https://datatracker.ietf.org/doc/html/draft-pantos-hls-rfc8216bis-18#section-4.4.6.5

Implementations

impl<'a> SessionKey<'a>

pub fn builder() -> SessionKeyBuilder<'a, SessionKeyMethodNeedsToBeSet, SessionKeyUriNeedsToBeSet>

Starts a builder for producing Self.

For example, we could construct a SessionKey as such:

let session_key = SessionKey::builder()
    .with_method(Method::SampleAes)
    .with_uri("skd://1234")
    .with_keyformat("com.apple.streamingkeydelivery")
    .with_keyformatversions("1")
    .finish();

Note that the finish method is only callable if the builder has set method AND uri. Each of the following fail to compile:

let session_key = SessionKey::builder().finish();

let session_key = SessionKey::builder().method(Method::SampleAes).finish();

let session_key = SessionKey::builder().with_uri("skd://1234").finish();

pub fn method(&self) -> EnumeratedString<'_, Method>

Corresponds to the METHOD attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn uri(&self) -> &str

Corresponds to the URI attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn iv(&self) -> Option<&str>

Corresponds to the IV attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn keyformat(&self) -> &str

Corresponds to the KEYFORMAT attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn keyformatversions(&self) -> Option<&str>

Corresponds to the KEYFORMATVERSIONS attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn set_method(&mut self, method: impl Into<Cow<'a, str>>)

Sets the METHOD attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn set_uri(&mut self, uri: impl Into<Cow<'a, str>>)

Sets the URI attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn set_iv(&mut self, iv: impl Into<Cow<'a, str>>)

Sets the IV attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn unset_iv(&mut self)

Unset the IV attribute (sets it to None).

See Self for a link to the HLS documentation for this attribute.

pub fn set_keyformat(&mut self, keyformat: impl Into<Cow<'a, str>>)

Sets the KEYFORMAT attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn unset_keyformat(&mut self)

Unset the KEYFORMAT attribute (sets it to None).

See Self for a link to the HLS documentation for this attribute.

pub fn set_keyformatversions( &mut self, keyformatversions: impl Into<Cow<'a, str>>, )

Sets the KEYFORMATVERSIONS attribute.

See Self for a link to the HLS documentation for this attribute.

pub fn unset_keyformatversions(&mut self)

Unset the KEYFORMATVERSIONS attribute (sets it to None).

See Self for a link to the HLS documentation for this attribute.

Trait Implementations

impl<'a> Clone for SessionKey<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SessionKey<'a>

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

Formats the value using the given formatter.

impl<'a, Custom> From<SessionKey<'a>> for HlsLine<'a, Custom>

where Custom: CustomTag<'a>,

fn from(tag: SessionKey<'a>) -> Self

Converts to this type from the input type.

impl<'a> IntoInnerTag<'a> for SessionKey<'a>

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

Consume self and provide TagInner.

impl<'a> PartialEq for SessionKey<'a>

fn eq(&self, other: &Self) -> 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> TryFrom<UnknownTag<'a>> for SessionKey<'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.