Struct lofty::id3::v2::Frame

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

Represents an ID3v2 frame

Outdated Frames

ID3v2.2

ID3v2.2 frame IDs are 3 characters. When reading these tags, upgrade_v2 is used, which has a list of all of the common IDs that have a mapping to ID3v2.4. Any ID that fails to be converted will be stored as FrameId::Outdated, and it must be manually upgraded before it can be written. Lofty will not write ID3v2.2 tags.

ID3v2.3

ID3v2.3, unlike ID3v2.2, stores frame IDs in 4 characters like ID3v2.4. There are some IDs that need upgrading (See upgrade_v3), but anything that fails to be upgraded will not be stored as FrameId::Outdated, as it is likely not an issue to write.

Implementations

impl<'a> Frame<'a>

pub fn new<I, V>(id: I, value: V, flags: FrameFlags) -> Result<Self>where I: Into<Cow<'a, str>>, V: Into<FrameValue>,

Create a new frame

NOTE: This will accept both ID3v2.2 and ID3v2.3/4 frame IDs

Errors

• id is less than 3 or greater than 4 bytes
• id contains non-ascii characters

pub fn id_str(&self) -> &str

Extract the string from the FrameId

pub fn content(&self) -> &FrameValue

Returns the frame’s content

pub fn flags(&self) -> &FrameFlags

Returns a reference to the FrameFlags

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

Set the item’s flags

Trait Implementations

impl<'a> Clone for Frame<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Frame<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Frame<'a>

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<'a> PartialEq for Frame<'a>

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

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

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

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

impl<'a> Eq for Frame<'a>

impl<'a> StructuralEq for Frame<'a>