Struct id3::v1::Tag

pub struct Tag {
    pub title: String,
    pub artist: String,
    pub album: String,
    pub year: String,
    pub comment: String,
    pub track: Option<u8>,
    pub genre_id: u8,
    pub speed: Option<u8>,
    pub genre_str: Option<String>,
    pub start_time: Option<String>,
    pub end_time: Option<String>,
}

A structure containing ID3v1 metadata.

Fields

title: String

The full title (ID3v1 + extension if present).

artist: String

The full artist (ID3v1 + extension if present).

album: String

The full album (ID3v1 + extension if present).

year: String

The release year as four digits.

The ID3v1 format can only represent values between 0 and 9999 inclusive.

comment: String

A free-form comment.

track: Option<u8>

Number of the track. ID3v1.1 data.

genre_id: u8

The genre mapping is standardized up to 79, altough this implementation uses the Winamp extended genre list: https://de.wikipedia.org/wiki/Liste_der_ID3v1-Genres

speed: Option<u8>

1 (slow), 2, 3, 4 (fast) or None when not set. ID3v1 extended data.

genre_str: Option<String>

Free-form genre string. ID3v1 extended data.

start_time: Option<String>

The real start of the track, mmm:ss. ID3v1 extended data.

end_time: Option<String>

The real end of the track, mmm:ss. ID3v1 extended data.

Methods

impl Tag

pub fn new() -> Tag

Creates a new empty ID3v1 tag.

pub fn is_candidate(
    reader: impl Read + Seek
) -> Result<bool>

Checks whether the reader contains an ID3v1 tag.

The reader position will be reset back to the previous position before returning.

pub fn read_from(
    reader: impl Read + Seek
) -> Result<Tag>

Seeks to and reads a ID3v1 tag from the reader.

pub fn remove(file: &mut File) -> Result<bool>

Removes an ID3v1 tag plus possible extended data if any.

The file cursor position will be reset back to the previous position before returning.

Returns true if the file initially contained a tag.

pub fn genre(&self) -> Option<&str>

Returns genre_str, falling back to translating genre_id to a string.

Trait Implementations

impl Eq for Tag

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Tag> for Tag

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

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

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

This method tests for !=.

impl Default for Tag

fn default() -> Tag

Returns the "default value" for a type.

impl From<Tag> for Tag

fn from(tag_v1: Tag) -> Tag

Performs the conversion.

impl Hash for Tag

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 Debug for Tag

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

Formats the value using the given formatter.