Struct Id3v1Tag

pub struct Id3v1Tag {
    pub title: Option<String>,
    pub artist: Option<String>,
    pub album: Option<String>,
    pub year: Option<String>,
    pub comment: Option<String>,
    pub track_number: Option<u8>,
    pub genre: Option<u8>,
}

An ID3v1 tag

Supported file types

• FileType::Aac
• FileType::Ape
• FileType::Mpeg
• FileType::WavPack
• FileType::Mpc (READ ONLY)

ID3v1 is a severely limited format, with each field being incredibly small in size. All fields have been commented with their maximum sizes and any other additional restrictions.

Attempting to write a field greater than the maximum size will not error, it will just be shrunk.

Conversions

To Tag

All fields can be translated to a TagItem:

• title -> ItemKey::TrackTitle
• artist -> ItemKey::TrackArtist
• album -> ItemKey::AlbumTitle
• year -> ItemKey::Year
• comment -> ItemKey::Comment
• track_number -> ItemKey::TrackNumber
• genre -> ItemKey::Genre (As long as the genre is a valid index into GENRES)

From Tag

All of the ItemKeys referenced in the conversion to Tag will be checked.

The values will be used as-is, with two exceptions:

• ItemKey::TrackNumber - Will only be used if the value can be parsed as a u8

• ItemKey::Genre - Will only be used if:

  GENRES contains the string OR The ItemValue can be parsed into a u8 and it is a valid index into GENRES

Fields

title: Option<String>

Track title, 30 bytes max

artist: Option<String>

Track artist, 30 bytes max

album: Option<String>

Album title, 30 bytes max

year: Option<String>

Release year, 4 bytes max

comment: Option<String>

A short comment

The number of bytes differs between versions, but not much. A V1 tag may have been read, which limits this field to 30 bytes. A V1.1 tag, however, only has 28 bytes available.

Lofty will always write a V1.1 tag.

track_number: Option<u8>

The track number, 1 byte max

Issues:

• The track number cannot be 0. Many readers, including Lofty, look for a null byte at the end of the comment to differentiate between V1 and V1.1.
• A V1 tag may have been read, which does not have a track number.

genre: Option<u8>

The track’s genre, 1 byte max

ID3v1 has a predefined set of genres, see GENRES. This byte should be an index to a genre.

Implementations

impl Id3v1Tag

pub fn new() -> Self

Create a new empty ID3v1Tag

Examples

use lofty::id3::v1::Id3v1Tag;
use lofty::tag::TagExt;

let id3v1_tag = Id3v1Tag::new();
assert!(id3v1_tag.is_empty());

Trait Implementations

impl Accessor for Id3v1Tag

fn title(&self) -> Option<Cow<'_, str>>

Returns the title

fn set_title(&mut self, value: String)

Sets the title

fn remove_title(&mut self)

Removes the title

fn artist(&self) -> Option<Cow<'_, str>>

Returns the artist

fn set_artist(&mut self, value: String)

Sets the artist

fn remove_artist(&mut self)

Removes the artist

fn album(&self) -> Option<Cow<'_, str>>

Returns the album

fn set_album(&mut self, value: String)

Sets the album

fn remove_album(&mut self)

Removes the album

fn genre(&self) -> Option<Cow<'_, str>>

Returns the genre

fn set_genre(&mut self, genre: String)

Sets the genre

fn remove_genre(&mut self)

Removes the genre

fn track(&self) -> Option<u32>

Returns the track

fn set_track(&mut self, value: u32)

Sets the track

fn remove_track(&mut self)

Removes the track

fn comment(&self) -> Option<Cow<'_, str>>

Returns the comment

fn set_comment(&mut self, value: String)

Sets the comment

fn remove_comment(&mut self)

Removes the comment

fn year(&self) -> Option<u32>

Returns the year

fn set_year(&mut self, value: u32)

Sets the year

fn remove_year(&mut self)

Removes the year

fn track_total(&self) -> Option<u32>

Returns the track total

fn set_track_total(&mut self, _value: u32)

Sets the track total

fn remove_track_total(&mut self)

Removes the track total

fn disk(&self) -> Option<u32>

Returns the disk

fn set_disk(&mut self, _value: u32)

Sets the disk

fn remove_disk(&mut self)

Removes the disk

fn disk_total(&self) -> Option<u32>

Returns the disk total

fn set_disk_total(&mut self, _value: u32)

Sets the disk total

fn remove_disk_total(&mut self)

Removes the disk total

impl Clone for Id3v1Tag

fn clone(&self) -> Id3v1Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Id3v1Tag

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

Formats the value using the given formatter.

impl Default for Id3v1Tag

fn default() -> Id3v1Tag

Returns the “default value” for a type.

impl From<Id3v1Tag> for Tag

fn from(input: Id3v1Tag) -> Self

Converts to this type from the input type.

impl From<Tag> for Id3v1Tag

fn from(input: Tag) -> Self

Converts to this type from the input type.

impl PartialEq for Id3v1Tag

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl SplitTag for Id3v1Tag

type Remainder = SplitTagRemainder

The remainder of the split operation that is not represented in the resulting Tag.

fn split_tag(self) -> (Self::Remainder, Tag)

Extract and split generic contents into a Tag.

impl TagExt for Id3v1Tag

fn dump_to<W: Write>( &self, writer: &mut W, write_options: WriteOptions, ) -> Result<(), Self::Err>

Dumps the tag to a writer

Errors

• std::io::Error

type Err = LoftyError

The associated error which can be returned from IO operations

type RefKey<'a> = &'a ItemKey

The type of key used in the tag for non-mutating functions

fn len(&self) -> usize

Returns the number of items in the tag

fn contains<'a>(&'a self, key: Self::RefKey<'a>) -> bool

Whether the tag contains an item with the key

fn is_empty(&self) -> bool

Whether the tag has any items

fn save_to<F>( &self, file: &mut F, write_options: WriteOptions, ) -> Result<(), Self::Err>

where F: FileLike, LoftyError: From<<F as Truncate>::Error> + From<<F as Length>::Error>,

Save the tag to a FileLike

fn remove_from_path<P: AsRef<Path>>(&self, path: P) -> Result<(), Self::Err>

Remove a tag from a Path

fn remove_from<F>(&self, file: &mut F) -> Result<(), Self::Err>

where F: FileLike, LoftyError: From<<F as Truncate>::Error> + From<<F as Length>::Error>,

Remove a tag from a FileLike

fn clear(&mut self)

Clear the tag, removing all items

fn save_to_path<P: AsRef<Path>>( &self, path: P, write_options: WriteOptions, ) -> Result<(), Self::Err>

Save the tag to a path

impl Eq for Id3v1Tag

impl StructuralPartialEq for Id3v1Tag