Struct id3::frame::Frame

source ·

pub struct Frame { /* private fields */ }

Expand description

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§

source §

impl Frame

source

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.

source

pub fn set_encoding(self, encoding: Option<Encoding>) -> Self

Sets the encoding for this frame.

The encoding is actually a property of individual content and its serialization format. Public interfaces of ID3 typically follow Rust conventions such as UTF-8.

§Caveat

According to the standard, distinct encodings do not count towards uniqueness. However, some applications such as Serato do write multiple frames that should not co-exist in a single tag and uses the encoding to distinguish between such frames.

When set using this function, the encoding influences the way uniqueness is determined and using other interfaces to alter the tag this frame belongs to has the potential to remove this or other tags.

After decoding a tag, the initial encoding is only set for TXXX and GEOB frames.

source

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"));

source

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"));

source

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.

source

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.

source

pub fn content(&self) -> &Content

Returns the content of the frame.

source

pub fn tag_alter_preservation(&self) -> bool

Returns whether the tag_alter_preservation flag is set.

source

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

Sets the tag_alter_preservation flag.

source

pub fn file_alter_preservation(&self) -> bool

Returns whether the file_alter_preservation flag is set.

source

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

Sets the file_alter_preservation flag.

source

pub fn encoding(&self) -> Option<Encoding>

Returns the encoding of this frame

§Caveat

See Frame::set_encoding.

source

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.