Struct CommentFrame

pub struct CommentFrame<'a> {
    pub encoding: TextEncoding,
    pub language: Lang,
    pub description: String,
    pub content: String,
    /* private fields */
}

An ID3v2 comment frame

Similar to TXXX and WXXX frames, comments are told apart by their descriptions.

Fields

encoding: TextEncoding

The encoding of the description and comment text

language: Lang

ISO-639-2 language code (3 bytes)

description: String

Unique content description

content: String

The actual frame content

Implementations

impl CommentFrame<'_>

pub fn new( encoding: TextEncoding, language: Lang, description: String, content: String, ) -> Self

Create a new CommentFrame

pub fn id(&self) -> FrameId<'_>

Get the ID for the frame

pub fn flags(&self) -> FrameFlags

Get the flags for the frame

pub fn set_flags(&mut self, flags: FrameFlags)

Set the flags for the frame

pub fn parse<R>( reader: &mut R, frame_flags: FrameFlags, version: Id3v2Version, ) -> Result<Option<Self>>

where R: Read,

Read a CommentFrame from a slice

NOTE: This expects the frame header to have already been skipped

Errors

• Unable to decode the text

ID3v2.2:

• The encoding is not TextEncoding::Latin1 or TextEncoding::UTF16

pub fn as_bytes(&self, is_id3v23: bool) -> Result<Vec<u8>>

Convert a CommentFrame to a byte vec

NOTE: This does not include a frame header

Errors

• language is not exactly 3 bytes
• language contains invalid characters (Only 'a'..='z' and 'A'..='Z' allowed)

Trait Implementations

impl<'a> Clone for CommentFrame<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommentFrame<'a>

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

Formats the value using the given formatter.

impl<'a> From<CommentFrame<'a>> for Frame<'a>

fn from(value: CommentFrame<'a>) -> Self

Converts to this type from the input type.

impl Hash for CommentFrame<'_>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CommentFrame<'_>

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

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

const 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> Eq for CommentFrame<'a>