Crate id3

Expand description

§rust-id3

A library for reading and writing ID3 metadata.

§Implemented Features

ID3v1 reading
ID3v2.2, ID3v2.3, ID3v2.4 reading/writing
MP3, WAV and AIFF files
Latin1, UTF16 and UTF8 encodings
Text frames
Extended Text frames
Link frames
Extended Link frames
Comment frames
Lyrics frames
Synchronised Lyrics frames
Picture frames
Encapsulated Object frames
Chapter frames
Unsynchronisation
Compression
MPEG Location Lookup Table frames
Unique File Identifier frames
Involved People List frames
Tag and File Alter Preservation bits

§Examples

§Reading tag frames

use id3::{Tag, TagLike};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let tag = Tag::read_from_path("testdata/id3v24.id3")?;

    // Get a bunch of frames...
    if let Some(artist) = tag.artist() {
        println!("artist: {}", artist);
    }
    if let Some(title) = tag.title() {
        println!("title: {}", title);
    }
    if let Some(album) = tag.album() {
        println!("album: {}", album);
    }

    // Get frames before getting their content for more complex tags.
    if let Some(artist) = tag.get("TPE1").and_then(|frame| frame.content().text()) {
        println!("artist: {}", artist);
    }
    Ok(())
}

§Modifying any existing tag

use id3::{Error, ErrorKind, Tag, TagLike, Version};
use std::fs::copy;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let temp_file = std::env::temp_dir().join("music.mp3");
    copy("testdata/quiet.mp3", &temp_file)?;

    let mut tag = match Tag::read_from_path(&temp_file) {
        Ok(tag) => tag,
        Err(Error{kind: ErrorKind::NoTag, ..}) => Tag::new(),
        Err(err) => return Err(Box::new(err)),
    };

    tag.set_album("Fancy Album Title");

    tag.write_to_path(temp_file, Version::Id3v24)?;
    Ok(())
}

§Creating a new tag, overwriting any old tag

use id3::{Tag, TagLike, Frame, Version};
use id3::frame::Content;
use std::fs::copy;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let temp_file = std::env::temp_dir().join("music.mp3");
    copy("testdata/quiet.mp3", &temp_file)?;

    let mut tag = Tag::new();
    tag.set_album("Fancy Album Title");

    // Set the album the hard way.
    tag.add_frame(Frame::text("TALB", "album"));

    tag.write_to_path(temp_file, Version::Id3v24)?;
    Ok(())
}

§Handling damaged or files without a tag

use id3::{Tag, TagLike, partial_tag_ok, no_tag_ok};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let tag_result = Tag::read_from_path("testdata/id3v24.id3");

    // A partially decoded tag is set on the Err. partial_tag_ok takes it out and maps it to Ok.
    let tag_result = partial_tag_ok(tag_result);

    // no_tag_ok maps the NoTag error variant and maps it to Ok(None).
    let tag_result = no_tag_ok(tag_result);

    if let Some(tag) = tag_result? {
      // ..
    }

    Ok(())
}

§Contributing

Do you think you have found a bug? Then please report it via the GitHub issue tracker. Make sure to attach any problematic files that can be used to reproduce the issue. Such files are also used to create regression tests that ensure that your bug will never return.

When submitting pull requests, please prefix your commit messages with fix: or feat: for bug fixes and new features respectively. This is the Conventional Commits scheme that is used to automate some maintenance chores such as generating the changelog and inferring the next version number.

§Running tests

Tests require ffprobe (part of ffmpeg) to be present in $PATH.

cargo test --all-features

Re-exports§

pub use crate::frame::Content;
pub use crate::frame::Frame;
pub use crate::frame::Timestamp;

Modules§

frame: Contains types and methods for operating on ID3 frames.
v1: Utilities for working with ID3v1 tags.
v1v2: Combined API that handles both ID3v1 and ID3v2 tags at the same time.

Structs§

Encoder: The Encoder may be used to encode tags with custom settings.
Error: A structure able to represent any error that may occur while performing metadata operations.
Tag: An ID3 tag containing zero or more Frames.

Enums§

Encoding: Types of text encodings used in ID3 frames.
ErrorKind: Kinds of errors that may occur while performing metadata operations.
Version: Denotes the version of a tag.

Traits§

StorageFile: This trait is the combination of the std::io stream traits with an additional method to resize the file.
TagLike: TagLike is a trait that provides a set of useful default methods that make manipulation of tag frames easier.

Functions§

no_tag_ok: Takes a tag result and maps the NoTag kind to None. Any other error is returned as Err.
partial_tag_ok: Takes a tag result and maps any partial tag to Ok. An Ok result is left untouched. An Err without partial tag is returned as the initial error.

Type Aliases§

Result: Type alias for the result of tag operations.

Crate id3Copy item path