Enum id3::Content

#[non_exhaustive]
pub enum Content {
    Text(String),
    ExtendedText(ExtendedText),
    Link(String),
    ExtendedLink(ExtendedLink),
    Comment(Comment),
    Popularimeter(Popularimeter),
    Lyrics(Lyrics),
    SynchronisedLyrics(SynchronisedLyrics),
    Picture(Picture),
    EncapsulatedObject(EncapsulatedObject),
    Chapter(Chapter),
    MpegLocationLookupTable(MpegLocationLookupTable),
    Unknown(Unknown),
}

The decoded contents of a Frame.

Compatibility

It is important to note that the ID3 spec has a variety of extensions of which not all are implemented by this library. When a new frame content type is added, the signature of this enum changes. Hence, the non_exhaustive attribute is set.

However, when a new frame type variant is added, frames that would previously decode to Unknown are now decoded to their new variants. This would break user code, such as custom decoders, that was expecting Unknown.

In order to prevent breakage when this library adds a new frame type, users must use the Content::to_unknown method which will return an Unknown regardlesss of whether the frame content was successfully decoded.

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.

Text(String)

A value containing the parsed contents of a text frame.

ExtendedText(ExtendedText)

A value containing the parsed contents of a user defined text frame (TXXX).

Link(String)

A value containing the parsed contents of a web link frame.

ExtendedLink(ExtendedLink)

A value containing the parsed contents of a user defined web link frame (WXXX).

Comment(Comment)

A value containing the parsed contents of a comment frame (COMM).

Popularimeter(Popularimeter)

Popularimeter frame content (POPM).

Lyrics(Lyrics)

A value containing the parsed contents of a lyrics frame (USLT).

SynchronisedLyrics(SynchronisedLyrics)

A value containing the parsed contents of a synchronised lyrics frame (SYLT).

Picture(Picture)

A value containing the parsed contents of a picture frame (APIC).

EncapsulatedObject(EncapsulatedObject)

A value containing the parsed contents of a general encapsulated object frame (GEOB).

Chapter(Chapter)

A chapter object containing frames by itself (CHAP).

MpegLocationLookupTable(MpegLocationLookupTable)

MPEG location lookup table content (MLLT).

Unknown(Unknown)

A value containing the bytes of a currently unknown frame type.

Users that wish to write custom decoders must use Content::to_unknown instead of matching on this variant. See the compatibility note in the top level enum docs.

Implementations

impl Content

pub fn new_text_values(
    texts: impl IntoIterator<Item = impl Into<String>>
) -> Self

Constructs a new Text Content from the specified set of strings.

Panics

If any of the strings contain a null byte.

Example

use id3::frame::Content;

let c = Content::new_text_values(["foo", "bar", "baz"]);
assert_eq!(c, Content::Text("foo\u{0}bar\u{0}baz".to_string()))

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

Returns the Text or None if the value is not Text.

pub fn text_values(&self) -> Option<impl Iterator<Item = &str>>

Returns split values of the Text frame or None if the value is not Text. This is only useful for ID3v2.4 tags, which support text frames containing multiple values separated by null bytes. This method returns an iterator over the separated values.

pub fn extended_text(&self) -> Option<&ExtendedText>

Returns the ExtendedText or None if the value is not ExtendedText.

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

Returns the Link or None if the value is not Link.

pub fn extended_link(&self) -> Option<&ExtendedLink>

Returns the ExtendedLink or None if the value is not ExtendedLink.

pub fn encapsulated_object(&self) -> Option<&EncapsulatedObject>

Returns the EncapsulatedObject or None if the value is not EncapsulatedObject.

pub fn comment(&self) -> Option<&Comment>

Returns the Comment or None if the value is not Comment.

pub fn lyrics(&self) -> Option<&Lyrics>

Returns the Lyrics or None if the value is not Lyrics.

pub fn synchronised_lyrics(&self) -> Option<&SynchronisedLyrics>

Returns the SynchronisedLyrics or None if the value is not SynchronisedLyrics.

pub fn picture(&self) -> Option<&Picture>

Returns the Picture or None if the value is not Picture.

pub fn chapter(&self) -> Option<&Chapter>

Returns the Chapter or None if the value is not Chapter.

pub fn mpeg_location_lookup_table(&self) -> Option<&MpegLocationLookupTable>

Returns the MpegLocationLookupTable or None if the value is not MpegLocationLookupTable.

pub fn unknown(&self) -> Option<&[u8]>

👎 Deprecated:

Use to_unknown

Returns the Unknown or None if the value is not Unknown.

pub fn to_unknown(&self) -> Result<Cow<'_, Unknown>>

Returns the Unknown variant or an ad-hoc encoding of any other variant.

See the compatibility note on the docs of Content for the reason of why this function exists.

Trait Implementations

impl Clone for Content

fn clone(&self) -> Content

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Content

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

Formats the value using the given formatter.

impl Display for Content

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

Formats the value using the given formatter.

impl Hash for Content

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 Content

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

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

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

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

This method tests for !=.

impl PartialOrd<Content> for Content

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

impl StructuralEq for Content

impl StructuralPartialEq for Content