Struct id3::frame::Frame

pub struct Frame { /* private fields */ }

A structure representing an ID3 frame.

The Content must be accompanied by a matching ID. Although this struct allows for invalid combinations to exist, attempting to encode them will yield an error.

Implementations

impl Frame

pub fn with_content(id: impl AsRef<str>, content: Content) -> Self

Creates a frame with the specified ID and content.

Both ID3v2.2 and >ID3v2.3 IDs are accepted, although they will be converted to ID3v2.3 format. If an ID3v2.2 ID is supplied but could not be remapped, it is stored as-is.

Panics

If the id’s length is not 3 or 4 bytes long.

pub fn text(id: impl AsRef<str>, content: impl Into<String>) -> Self

Creates a new text frame with the specified ID and text content.

This function does not verify whether the ID is valid for text frames.

Example

use id3::Frame;

let frame = Frame::text("TPE1", "Armin van Buuren");
assert_eq!(frame.content().text(), Some("Armin van Buuren"));

pub fn link(id: impl AsRef<str>, content: impl Into<String>) -> Self

Creates a new link frame with the specified ID and link content.

This function does not verify whether the ID is valid for link frames.

Example

use id3::Frame;

let frame = Frame::link("WCOM", "https://wwww.arminvanbuuren.com");
assert_eq!(frame.content().link(), Some("https://wwww.arminvanbuuren.com"));

pub fn id(&self) -> &str

Returns the ID of this frame.

The string returned us usually 4 bytes long except when the frame was read from an ID3v2.2 tag and the ID could not be mapped to an ID3v2.3 ID.

pub fn id_for_version(&self, version: Version) -> Option<&str>

Returns the ID that is compatible with specified version or None if no ID is available in that version.

pub fn content(&self) -> &Content

Returns the content of the frame.

pub fn tag_alter_preservation(&self) -> bool

Returns whether the tag_alter_preservation flag is set.

pub fn set_tag_alter_preservation(&mut self, tag_alter_preservation: bool)

Sets the tag_alter_preservation flag.

pub fn file_alter_preservation(&self) -> bool

Returns whether the file_alter_preservation flag is set.

pub fn set_file_alter_preservation(&mut self, file_alter_preservation: bool)

Sets the file_alter_preservation flag.

pub fn name(&self) -> &str

Returns the name of the frame.

The name is the human-readable representation of a frame id. For example, the id "TCOM" corresponds to the name "Composer". The names are taken from the ID3v2.4, ID3v2.3 and ID3v2.2 standards.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Display for Frame

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

Formats the value using the given formatter.

impl Extend<Frame> for Chapter

fn extend<I: IntoIterator<Item = Frame>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Frame> for Tag

fn extend<I: IntoIterator<Item = Frame>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Chapter> for Frame

fn from(c: Chapter) -> Self

Converts to this type from the input type.

impl From<Comment> for Frame

fn from(c: Comment) -> Self

Converts to this type from the input type.

impl From<EncapsulatedObject> for Frame

fn from(c: EncapsulatedObject) -> Self

Converts to this type from the input type.

impl From<ExtendedLink> for Frame

fn from(c: ExtendedLink) -> Self

Converts to this type from the input type.

impl From<ExtendedText> for Frame

fn from(c: ExtendedText) -> Self

Converts to this type from the input type.

impl From<Lyrics> for Frame

fn from(c: Lyrics) -> Self

Converts to this type from the input type.

impl From<MpegLocationLookupTable> for Frame

fn from(c: MpegLocationLookupTable) -> Self

Converts to this type from the input type.

impl From<Picture> for Frame

fn from(c: Picture) -> Self

Converts to this type from the input type.

impl From<Popularimeter> for Frame

fn from(c: Popularimeter) -> Self

Converts to this type from the input type.

impl From<SynchronisedLyrics> for Frame

fn from(c: SynchronisedLyrics) -> Self

Converts to this type from the input type.

impl FromIterator<Frame> for Tag

fn from_iter<I: IntoIterator<Item = Frame>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Frame

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 Frame

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

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

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

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

This method tests for !=.

impl PartialOrd<Frame> for Frame

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

impl StructuralEq for Frame

impl StructuralPartialEq for Frame