Struct id3::frame::Frame

pub struct Frame { /* fields omitted */ }

A structure representing an ID3 frame.

It is imporant to note that the (Partial)Eq and Hash implementations are based on the ID3 spec. This means that text frames with equal ID's are equal but picture frames with both "APIC" as ID are not because their uniqueness is also defined by their content.

Methods

impl Frame

fn new<T: Into<String>>(id: T) -> Frame

Deprecated

: Use with_content

Creates a new ID3v2.3 frame with the specified identifier.

Panics

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

fn with_content(id: &str, content: Content) -> Frame

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.

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.

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.

fn content(&self) -> &Content

Returns the content of the frame.

fn tag_alter_preservation(&self) -> bool

Returns whether the tag_alter_preservation flag is set.

fn set_tag_alter_preservation(&mut self, tag_alter_preservation: bool)

Sets the tag_alter_preservation flag.

fn file_alter_preservation(&self) -> bool

Returns whether the file_alter_preservation flag is set.

fn set_file_alter_preservation(&mut self, file_alter_preservation: bool)

Sets the file_alter_preservation flag.

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

Deprecated

: Format using fmt::Display

Returns a string representing the parsed content.

Returns None if the parsed content can not be represented as text.

Example

use id3::frame::{self, Frame, Content};

let title_frame = Frame::with_content("TIT2", Content::Text("title".to_owned()));
assert_eq!(&title_frame.text().unwrap()[..], "title");

let mut txxx_frame = Frame::with_content("TXXX", Content::ExtendedText(frame::ExtendedText {
    description: "description".to_owned(),
    value: "value".to_owned()
}));
assert_eq!(&txxx_frame.text().unwrap()[..], "description: value");

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, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Frame

impl PartialEq 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: &Rhs) -> bool

This method tests for !=.

impl Hash for Frame

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

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 Display for Frame

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

Formats the value using the given formatter.