rust-id3

https://docs.rs/id3/1.16.3/
Admin
A Rust library for reading and writing ID3 metadata in MP3, WAV, and AIFF files with support for...
Tokens:153,806
Snippets:686
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Frame Example

Source: https://docs.rs/id3/1.16.3/id3/trait

This example demonstrates how to use the `get` method from the `TagLike` trait to retrieve a specific frame from an ID3 tag. It shows how to check for the existence of a frame by its identifier.

```Rust
use id3::{Tag, TagLike, Frame, Content};

let mut tag = Tag::new();

tag.add_frame(Frame::text("TIT2", "Hello"));

assert!(tag.get("TIT2").is_some());
assert!(tag.get("TCON").is_none());

```

--------------------------------

### Rust: Unwrap Ok and Err values

Source: https://docs.rs/id3/1.16.3/id3/type

Demonstrates the basic usage of `unwrap` on a `Result` type. The first example shows unwrapping an `Ok` value. The second example shows unwrapping an `Err` value, which will cause a panic with the provided error message.

```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(x.unwrap(), 2);
```

```rust
let x: Result<u32, &str> = Err("emergency failure");
x.unwrap(); // panics with `emergency failure`
```

--------------------------------

### Album API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the album information for the audio file. Supports setting, getting, and removing the album.

```APIDOC
## Album Operations

### Get Album

#### Description
Retrieves the album information from the TALB frame.

#### Method
GET

#### Endpoint
`/tag/album`

#### Response
##### Success Response (200)
- **album** (string) - The album name.

##### Response Example
```json
{
  "album": "Album Name"
}
```

### Set Album

#### Description
Sets the album information for the audio file by adding or updating the TALB frame.

#### Method
POST

#### Endpoint
`/tag/album`

#### Request Body
- **album** (string) - Required - The album name to set.

#### Request Example
```json
{
  "album": "New Album Name"
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Album updated successfully."
}
```

### Remove Album

#### Description
Removes the album information from the TALB frame.

#### Method
DELETE

#### Endpoint
`/tag/album`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Album removed successfully."
}
```
```

--------------------------------

### Title API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the title information for the audio file. Supports setting, getting, and removing the title.

```APIDOC
## Title Operations

### Get Title

#### Description
Retrieves the title information from the TIT2 frame.

#### Method
GET

#### Endpoint
`/tag/title`

#### Response
##### Success Response (200)
- **title** (string) - The title of the track.

##### Response Example
```json
{
  "title": "Track Title"
}
```

### Set Title

#### Description
Sets the title information for the audio file by adding or updating the TIT2 frame.

#### Method
POST

#### Endpoint
`/tag/title`

#### Request Body
- **title** (string) - Required - The title to set.

#### Request Example
```json
{
  "title": "New Track Title"
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Title updated successfully."
}
```

### Remove Title

#### Description
Removes the title information from the TIT2 frame.

#### Method
DELETE

#### Endpoint
`/tag/title`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Title removed successfully."
}
```
```

--------------------------------

### Get Year

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

Retrieves the year from the TYER frame. Returns `None` if the frame is not found or cannot be parsed.

```APIDOC
## GET /api/tags/year

### Description
Retrieves the year from the TYER frame. Returns `None` if the frame is not found or cannot be parsed.

### Method
GET

### Endpoint
/api/tags/year

### Response
#### Success Response (200)
- **year** (integer) - The year, or null if not found/parsable.

#### Response Example
```json
{
  "year": 2014
}
```
```

--------------------------------

### Artist API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the artist information for the audio file. Supports setting, getting, and removing the artist.

```APIDOC
## Artist Operations

### Get Artist

#### Description
Retrieves the artist information from the TPE1 frame.

#### Method
GET

#### Endpoint
`/tag/artist`

#### Response
##### Success Response (200)
- **artist** (string) - The artist name.

##### Response Example
```json
{
  "artist": "Artist Name"
}
```

### Set Artist

#### Description
Sets the artist information for the audio file by adding or updating the TPE1 frame.

#### Method
POST

#### Endpoint
`/tag/artist`

#### Request Body
- **artist** (string) - Required - The artist name to set.

#### Request Example
```json
{
  "artist": "New Artist Name"
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Artist updated successfully."
}
```

### Remove Artist

#### Description
Removes the artist information from the TPE1 frame.

#### Method
DELETE

#### Endpoint
`/tag/artist`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Artist removed successfully."
}
```
```

--------------------------------

### Date Released API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the release date of the audio file. Supports setting, getting, and removing the release date.

```APIDOC
## Date Released Operations

### Get Date Released

#### Description
Retrieves the release date from the TDOR frame if it exists.

#### Method
GET

#### Endpoint
`/tag/date_released`

#### Response
##### Success Response (200)
- **date_released** (Timestamp) - The release date of the audio file.

##### Response Example
```json
{
  "date_released": {
    "year": 2014,
    "month": null,
    "day": null
  }
}
```

### Set Date Released

#### Description
Sets the release date for the audio file by adding or updating the TDOR frame.

#### Method
POST

#### Endpoint
`/tag/date_released`

#### Request Body
- **date_released** (Timestamp) - Required - The release date to set.

#### Request Example
```json
{
  "date_released": {
    "year": 2014,
    "month": 10,
    "day": 26
  }
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Date released updated successfully."
}
```

### Remove Date Released

#### Description
Removes the release date from the TDOR frame.

#### Method
DELETE

#### Endpoint
`/tag/date_released`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Date released removed successfully."
}
```
```

--------------------------------

### Write Tagless WAV File with Edits in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/tag

This example copies a tagless WAV file to a temporary location and then uses `edit_and_check_wav_tag` to write tags from a different source file ('testdata/wav/tagged-mid.wav') into it.

```rust
let tmp = tempfile::NamedTempFile::new().unwrap();
std::fs::copy("testdata/wav/tagless.wav", &tmp).unwrap();

edit_and_check_wav_tag("testdata/wav/tagged-mid.wav", &tmp).unwrap();
```

--------------------------------

### Original Date Released API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the original release date of the audio file. Supports setting, getting, and removing the original release date.

```APIDOC
## Original Date Released Operations

### Get Original Date Released

#### Description
Retrieves the original release date from the TDOR frame if it exists.

#### Method
GET

#### Endpoint
`/tag/original_date_released`

#### Response
##### Success Response (200)
- **original_date_released** (Timestamp) - The original release date of the audio file.

##### Response Example
```json
{
  "original_date_released": {
    "year": 2014,
    "month": null,
    "day": null
  }
}
```

### Set Original Date Released

#### Description
Sets the original release date for the audio file by adding or updating the TDOR frame.

#### Method
POST

#### Endpoint
`/tag/original_date_released`

#### Request Body
- **original_date_released** (Timestamp) - Required - The original release date to set.

#### Request Example
```json
{
  "original_date_released": {
    "year": 2014,
    "month": 10,
    "day": 26
  }
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Original date released updated successfully."
}
```

### Remove Original Date Released

#### Description
Removes the original release date from the TDOR frame.

#### Method
DELETE

#### Endpoint
`/tag/original_date_released`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Original date released removed successfully."
}
```
```

--------------------------------

### Album Metadata API

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

Manage the album (TALB) information within ID3 tags. Supports getting, setting, and removing the album.

```APIDOC
## GET /api/tags/album

### Description
Retrieves the album (TALB) information from the ID3 tag.

### Method
GET

### Endpoint
/api/tags/album

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **album** (string) - The album name.

#### Response Example
{
  "album": "Example Album"
}

## POST /api/tags/album

### Description
Sets the album (TALB) information in the ID3 tag.

### Method
POST

### Endpoint
/api/tags/album

### Parameters
#### Request Body
- **album** (string) - Required - The album name to set.

### Request Example
```json
{
  "album": "New Album Name"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Album set successfully."
}

## DELETE /api/tags/album

### Description
Removes the album (TALB) information from the ID3 tag.

### Method
DELETE

### Endpoint
/api/tags/album

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Album removed successfully."
}
```

--------------------------------

### Rust Crate Initialization and Exports

Source: https://docs.rs/id3/1.16.3/src/id3/lib

This snippet shows the main entry point for the id3 Rust crate. It includes attribute directives for documentation and linting, and re-exports key types and modules for public use. Dependencies include standard library features and potentially other crates for specific functionalities.

```rust
#![doc = include_str!("../README.md")]
#![deny(missing_docs)]
#![deny(clippy::all)]

// Resources:
// * ID3v2.2 <http://id3.org/id3v2-00>
// * ID3v2.3 <http://id3.org/id3v2.3.0>
// * ID3v2.4 <http://id3.org/id3v2.4.0-structure>

pub use crate::error::{no_tag_ok, partial_tag_ok, Error, ErrorKind, Result};
pub use crate::frame::{Content, Frame, Timestamp};
pub use crate::storage::StorageFile;
pub use crate::stream::encoding::Encoding;
pub use crate::stream::tag::Encoder;
pub use crate::tag::{Tag, Version};
pub use crate::taglike::TagLike;

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

mod chunk;
mod error;
mod storage;
mod stream;
mod tag;
mod taglike;
mod tcon;

```

--------------------------------

### Get Minor Version from ID3 Tag Version in Rust

Source: https://docs.rs/id3/1.16.3/id3/enum

Provides an example of how to use the `minor()` method on the `Version` enum to retrieve the minor version number. This is useful for specific version checks or comparisons.

```rust
use id3::Version;

assert_eq!(Version::Id3v24.minor(), 4);
```

--------------------------------

### Running ID3 Crate Tests in Rust

Source: https://docs.rs/id3/1.16.3/id3/index

Explains how to run the tests for the `id3` crate. It specifies that `ffprobe` (from the ffmpeg package) must be available in the system's PATH and provides the cargo command to execute the tests with all features enabled.

```rust
cargo test --all-features
```

--------------------------------

### Get Genre from ID3 Tag in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

This code snippet demonstrates how to retrieve the genre from an ID3 tag using the `genre` method. It uses the `Frame`, `Tag`, and `TagLike` traits from the `id3` crate. The example adds a text frame for the genre and then retrieves the genre, asserting that the retrieved genre matches the set genre.

```Rust
/// use id3::{Frame, Tag, TagLike};
/// use id3::frame::Content;
///
/// let mut tag = Tag::new();
/// tag.add_frame(Frame::text("TCON", "genre"));
/// assert_eq!(tag.genre(), Some("genre"));
/// tag.set_genre("(31)");
/// assert_eq!(tag.genre(), Some("(31)"));
/// ```
fn genre(&self) -> Option<&str> {
    self.text_for_frame_id("TCON")
}
```

--------------------------------

### Execute ffprobe with file input and capture output in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/tag

This Rust function executes the `ffprobe` command-line tool to analyze a given file. It captures the standard error output, which typically contains metadata, and returns it as a string. It includes error handling for cases where `ffprobe` is not found or returns a non-zero exit status.

```rust
use std::process::Command;
use std::{self, io::Read, io::Seek};
use tempfile::tempdir;

fn ffprobe(file: impl AsRef<Path>) -> Result<String, Box<dyn Error>> {
    let output = Command::new("ffprobe")
        .arg(file.as_ref())
        .output()
        .map_err(|err| match err.kind() {
            io::ErrorKind::NotFound => io::Error::new(
                io::ErrorKind::NotFound,
                format!("{}. Is ffprobe present in $PATH?", err),
            ),
            _ => err,
        })?;
    if !output.status.success() {
        return Err(Box::new(io::Error::new(
            io::ErrorKind::Other,
            "ffprobe output status failure",
        )));
    }
    Ok(String::from_utf8(output.stderr)?)
}
```

--------------------------------

### Get Total Discs from ID3 Tag in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

This code snippet demonstrates how to retrieve the total number of discs from an ID3 tag using the `total_discs` method. The example adds a text frame for the disc number and total discs, and then retrieves the total discs, asserting the retrieved total discs matches the set value.

```Rust
/// use id3::{Frame, Tag, TagLike};
/// use id3::frame::Content;
///
/// let mut tag = Tag::new();
/// assert!(tag.disc().is_none());
///
/// tag.add_frame(Frame::text("TPOS", "4/10"));
/// assert_eq!(tag.total_discs(), Some(10));
///
/// tag.remove("TPOS");
///

```

--------------------------------

### Test Helper: Create File with Both ID3 Formats (Rust)

Source: https://docs.rs/id3/1.16.3/src/id3/v1v2

A test utility function that creates a temporary file containing both ID3v1 and ID3v2 tags. This is used to test scenarios where multiple tag versions are present.

```Rust
fn file_with_both_formats() -> tempfile::NamedTempFile {
    // Write both ID3v1 and ID3v2 tags to a single file, the ID3v2 should be prefered when
    // reading.
    let mut v2_testdata = File::open("testdata/id3v24.id3").unwrap();
    let mut v1_testdata = File::open("testdata/id3v1.id3").unwrap();
    let mut tmp = tempfile::NamedTempFile::new().unwrap();
    copy(&mut v2_testdata, &mut tmp).unwrap();
    tmp.write_all(&[0xaa; 1337]).unwrap(); // Dummy data, can be anything.
    copy(&mut v1_testdata, &mut tmp).unwrap();
    tmp
}
```

--------------------------------

### Get Parsed Genre from ID3 Tag in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

This code snippet demonstrates how to retrieve the parsed genre from an ID3 tag using the `genre_parsed` method. It uses the `Frame`, `Tag`, and `TagLike` traits from the `id3` crate. The example adds a text frame for the genre and retrieves the parsed genre, asserting that it matches the set genre, including handling ID3v1 genre indices.

```Rust
/// use id3::frame::Content;
/// use id3::{Frame, Tag, TagLike};
/// use std::borrow::Cow;
///
/// let mut tag = Tag::new();
/// tag.add_frame(Frame::text("TCON", "genre"));
/// assert_eq!(tag.genre_parsed(), Some(Cow::Borrowed("genre")));
/// tag.set_genre("(31)");
/// assert_eq!(tag.genre_parsed(), Some(Cow::Owned("Trance".to_string())));
/// ```
fn genre_parsed(&self) -> Option<Cow<str>> {
    let tcon = self.text_for_frame_id("TCON")?;
    Some(crate::tcon::Parser::parse_tcon(tcon))
}
```

--------------------------------

### Read and Work with ID3v1 Tags in Rust

Source: https://context7.com/context7/rs_id3_1_16_3/llms.txt

Provides a Rust code example for reading and accessing metadata from legacy ID3v1 tags using the `id3::v1::Tag` structure. It demonstrates opening an MP3 file and attempting to read the V1 tag, then printing fields such as title, artist, album, year, comment, track, and genre. Error handling is included for cases where no ID3v1 tag is present.

```rust
use id3::v1::Tag as V1Tag;
use std::fs::File;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Read ID3v1 tag
    let mut file = File::open("old_file.mp3")?;

    match V1Tag::read_from(&mut file) {
        Ok(tag) => {
            println!("Title: {}", tag.title);
            println!("Artist: {}", tag.artist);
            println!("Album: {}", tag.album);
            println!("Year: {}", tag.year);
            println!("Comment: {}", tag.comment);

            if let Some(track) = tag.track {
                println!("Track: {}", track);
            }

            println!("Genre: {:?}", tag.genre);
        },
        Err(e) => println!("No ID3v1 tag found: {}", e),
    }

    Ok(())
}

```

--------------------------------

### Get Disc Number from ID3 Tag in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

This code snippet demonstrates how to retrieve the disc number from an ID3 tag using the `disc` method. It utilizes the `Frame`, `Tag`, and `TagLike` traits. The example adds a text frame for the disc number and then retrieves it, asserting that the retrieved disc number matches the set value. It also handles cases where the disc number is not a valid number.

```Rust
/// use id3::{Frame, Tag, TagLike};
/// use id3::frame::Content;
///
/// let mut tag = Tag::new();
/// assert!(tag.disc().is_none());
///
/// tag.add_frame(Frame::text("TPOS", "4"));
/// assert_eq!(tag.disc(), Some(4));
///
/// tag.remove("TPOS");
///
/// tag.add_frame(Frame::text("TPOS", "nope"));
/// assert!(tag.disc().is_none());
/// ```
fn disc(&self) -> Option<u32> {
    self.disc_pair().map(|(disc, _)| disc)
}
```

--------------------------------

### Handle Partial Tags in Rust with id3

Source: https://context7.com/context7/rs_id3_1_16_3/llms.txt

Shows how to gracefully handle potentially damaged audio files and recover partial ID3 tag data using the id3 Rust library. It utilizes `partial_tag_ok` to attempt reading a tag, even if errors occur, and `no_tag_ok` to convert errors where no tag exists into an `Option::None`. This allows for checking recovered metadata even from incomplete tags.

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

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Attempt to read potentially damaged file
    let tag_result = Tag::read_from_path("possibly_damaged.mp3");

    // Extract partial tag if available (errors may have partial_tag set)
    let tag_result = partial_tag_ok(tag_result);

    // Convert NoTag error to None
    let tag_option = no_tag_ok(tag_result)?;

    match tag_option {
        Some(tag) => {
            println!("Tag read successfully (possibly partial)");

            // Check what we got
            if let Some(artist) = tag.artist() {
                println!("Artist: {}", artist);
            }
            if let Some(title) = tag.title() {
                println!("Title: {}", title);
            }

            // Count frames that were recovered
            let frame_count = tag.frames().count();
            println!("Recovered {} frames", frame_count);
        },
        None => {
            println!("No tag found in file");
        }
    }

    Ok(())
}

```

--------------------------------

### Parse Chapter Content in Rust

Source: https://docs.rs/id3/1.16.3/src/id3/stream/frame/content

Parses the chapter (CHAP) frame content from an ID3 tag. It extracts the element ID, start and end times, start and end offsets, and any nested frames within the chapter.

```Rust
fn chapter_content(mut self) -> crate::Result<Content> {
        let element_id = self.string_delimited(Encoding::Latin1)?;
        let start_time = self.uint32()?;
        let end_time = self.uint32()?;
        let start_offset = self.uint32()?;
        let end_offset = self.uint32()?;
        let mut frames = Vec::new();
        while let Some((_advance, frame)) = frame::decode(&mut self.r, self.version)? {
            frames.push(frame);
        }
        Ok(Content::Chapter(Chapter {
            element_id,
            start_time,
            end_time,
            start_offset,
            end_offset,
            frames,
        }))
    }
```

--------------------------------

### Write ID3 Tags to Specific Versions (Rust)

Source: https://context7.com/context7/rs_id3_1_16_3/llms.txt

Demonstrates how to create an ID3 tag and write it to a file using specific ID3v2 versions (v2.2, v2.3, v2.4). This is useful when compatibility with older or newer media players is required. It requires the 'id3' crate.

```rust
use id3::{Tag, TagLike, Version};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut tag = Tag::new();

    tag.set_title("Test Song");
    tag.set_artist("Test Artist");

    // Write as different versions
    tag.write_to_path("v22.mp3", Version::Id3v22)?;
    tag.write_to_path("v23.mp3", Version::Id3v23)?;
    tag.write_to_path("v24.mp3", Version::Id3v24)?;

    Ok(())
}
```

--------------------------------

### Handling File Metadata with `and_then` in Rust

Source: https://docs.rs/id3/1.16.3/id3/type

Shows how to use `and_then` to chain operations involving file system metadata, such as retrieving modification times. This example illustrates handling potential errors like `NotFound` when accessing file paths.

```rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

--------------------------------

### Encode Chapter Content (Rust)

Source: https://docs.rs/id3/1.16.3/src/id3/stream/frame/content

Encodes chapter content for ID3v2.3 tags. This includes the chapter element ID, start and end times, start and end offsets, and any associated frames. The element ID is encoded using Latin1.

```rust
fn chapter_content(&mut self, content: &Chapter) -> crate::Result<()>
    {
        self.string_with_other_encoding(Encoding::Latin1, &content.element_id)?;
        self.byte(0)?;
        self.uint32(content.start_time)?;
        self.uint32(content.end_time)?;
        self.uint32(content.start_offset)?;
        self.uint32(content.end_offset)?;
        for frame in &content.frames {
            frame::encode(&mut self.w, frame, self.version, false)?;
        }
        Ok(())
    }
```

--------------------------------

### Get Date Recorded

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

Retrieves the date recorded from the TDRC frame.

```APIDOC
## GET /api/tags/date_recorded

### Description
Retrieves the date recorded from the TDRC frame.

### Method
GET

### Endpoint
/api/tags/date_recorded

### Response
#### Success Response (200)
- **dateRecorded** (object) - The date recorded information, including year, month, day, hour, minute, and second.

#### Response Example
```json
{
  "dateRecorded": {
    "year": 2014,
    "month": null,
    "day": null,
    "hour": null,
    "minute": null,
    "second": null
  }
}
```
```

--------------------------------

### Read ID3 Tag from Reader with Format Detection (Synchronous)

Source: https://docs.rs/id3/1.16.3/src/id3/tag

Attempts to read an ID3 tag from a reader, automatically detecting the audio format (Header, AIFF, WAV) using the header magic. For AIFF/WAV with ID3 headers, the ID3 header takes precedence. Requires `io::Read` and `io::Seek` capabilities.

```rust
/// Attempts to read an ID3 tag from the reader.
///
/// The file format is detected using header magic.
///
/// In the case of both Aiff/Wav tags and a ID3 header being present, the header takes
/// precense.
pub fn read_from2(reader: impl io::Read + io::Seek) -> crate::Result<Tag> {
    let mut b = BufReader::new(reader);
    let probe = b.fill_buf()?;

    match Format::magic(probe) {
        Some(Format::Header) | None => stream::tag::decode(b),
        Some(Format::Aiff) => chunk::load_id3_chunk::<chunk::AiffFormat, _>(b),
        Some(Format::Wav) => chunk::load_id3_chunk::<chunk::WavFormat, _>(b),
    }
}
```

--------------------------------

### Add and Read Chapters in Rust ID3 Tags

Source: https://context7.com/context7/rs_id3_1_16_3/llms.txt

Demonstrates how to create, add, and read chapter information within ID3 tags using the id3 Rust library. It shows how to define chapters with start/end times and associated metadata frames, and how to iterate through existing chapters in a tag. Chapters are represented by the `Chapter` struct, and metadata is added using `Frame::text`.

```rust
use id3::{Tag, TagLike, Frame, Version};
use id3::frame::{Chapter, Content};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut tag = Tag::new();

    // Create chapter with frames
    let mut chapter = Chapter {
        element_id: "chap1".to_string(),
        start_time: 0,          // Start at 0 milliseconds
        end_time: 60000,        // End at 60000 milliseconds (1 minute)
        start_offset: 0xffffffff, // Not using byte offsets
        end_offset: 0xffffffff,
        frames: Vec::new(),
    };

    // Add metadata to chapter
    chapter.add_frame(Frame::text("TIT2", "Introduction"));
    chapter.add_frame(Frame::text("TIT3", "Opening remarks"));

    // Add chapter to tag
    tag.add_frame(chapter);

    // Add more chapters
    let mut chapter2 = Chapter {
        element_id: "chap2".to_string(),
        start_time: 60000,
        end_time: 180000,
        start_offset: 0xffffffff,
        end_offset: 0xffffffff,
        frames: Vec::new(),
    };
    chapter2.add_frame(Frame::text("TIT2", "Main Content"));
    tag.add_frame(chapter2);

    // Read chapters from tag
    for frame in tag.frames() {
        if let Some(chap) = frame.content().chapter() {
            println!("Chapter: {} ({} ms - {} ms)",
                chap.element_id, chap.start_time, chap.end_time);
            for subframe in &chap.frames {
                if let Some(title) = subframe.content().text() {
                    println!("  Title: {}", title);
                }
            }
        }
    }

    // Remove all chapters
    tag.remove_all_chapters();

    tag.write_to_path("audiobook.mp3", Version::Id3v24)?;
    Ok(())
}

```

--------------------------------

### Duration API

Source: https://docs.rs/id3/1.16.3/id3/trait

Manage the duration information for the audio file. Supports setting, getting, and removing the duration.

```APIDOC
## Duration Operations

### Get Duration

#### Description
Retrieves the duration of the audio file from the TLEN frame.

#### Method
GET

#### Endpoint
`/tag/duration`

#### Response
##### Success Response (200)
- **duration** (integer) - The duration of the track in seconds.

##### Response Example
```json
{
  "duration": 350
}
```

### Set Duration

#### Description
Sets the duration for the audio file by adding or updating the TLEN frame.

#### Method
POST

#### Endpoint
`/tag/duration`

#### Request Body
- **duration** (integer) - Required - The duration in seconds to set.

#### Request Example
```json
{
  "duration": 400
}
```

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful update.

##### Response Example
```json
{
  "message": "Duration updated successfully."
}
```

### Remove Duration

#### Description
Removes the duration information from the TLEN frame.

#### Method
DELETE

#### Endpoint
`/tag/duration`

#### Response
##### Success Response (200)
- **message** (string) - Indicates successful removal.

##### Response Example
```json
{
  "message": "Duration removed successfully."
}
```
```

--------------------------------

### Result Handling Methods

Source: https://docs.rs/id3/1.16.3/id3/type

Demonstrates common methods for working with Rust's Result type, such as chaining fallible operations, providing default values, and handling errors.

```APIDOC
## `and_then`

### Description
Chains fallible operations that may return `Err`. If the `Result` is `Ok`, the closure is applied to the contained value. If the `Result` is `Err`, the `Err` is returned.

### Method
`and_then`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
fn sq_then_to_string(x: u32) -> Result<String, &'static str> {
    x.checked_mul(x).map(|sq| sq.to_string()).ok_or("overflowed")
}

assert_eq!(Ok(2).and_then(sq_then_to_string), Ok("4".to_string()));
assert_eq!(Err::<u32, _>("not a number").and_then(sq_then_to_string), Err("not a number"));
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `or`

### Description
Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`. Arguments passed to `or` are eagerly evaluated.

### Method
`or`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let x: Result<u32, &str> = Ok(2);
let y: Result<u32, &str> = Err("late error");
assert_eq!(x.or(y), Ok(2));

let x: Result<u32, &str> = Err("early error");
let y: Result<u32, &str> = Ok(2);
assert_eq!(x.or(y), Ok(2));
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `or_else`

### Description
Calls `op` if the result is `Err`, otherwise returns the `Ok` value of `self`. This function can be used for control flow based on result values.

### Method
`or_else`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
fn err(x: u32) -> Result<u32, u32> { Err(x) }

assert_eq!(Ok(2).or_else(sq).or_else(sq), Ok(2));
assert_eq!(Err(3).or_else(sq).or_else(err), Ok(9));
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `unwrap_or`

### Description
Returns the contained `Ok` value or a provided default. Arguments passed to `unwrap_or` are eagerly evaluated.

### Method
`unwrap_or`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let default = 2;
let x: Result<u32, &str> = Ok(9);
assert_eq!(x.unwrap_or(default), 9);

let x: Result<u32, &str> = Err("error");
assert_eq!(x.unwrap_or(default), default);
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `unwrap_or_else`

### Description
Returns the contained `Ok` value or computes it from a closure. This is lazily evaluated.

### Method
`unwrap_or_else`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
fn count(x: &str) -> usize { x.len() }

assert_eq!(Ok(2).unwrap_or_else(count), 2);
assert_eq!(Err("foo").unwrap_or_else(count), 3);
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `unwrap_unchecked`

### Description
Returns the contained `Ok` value, consuming the `self` value, without checking that the value is not an `Err`. **Safety**: Calling this method on an `Err` is undefined behavior.

### Method
`unwrap_unchecked`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let x: Result<u32, &str> = Ok(2);
assert_eq!(unsafe { x.unwrap_unchecked() }, 2);
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)

## `unwrap_err_unchecked`

### Description
Returns the contained `Err` value, consuming the `self` value, without checking that the value is not an `Ok`. **Safety**: Calling this method on an `Ok` is undefined behavior.

### Method
`unwrap_err_unchecked`

### Endpoint
N/A (Method on `Result` type)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
let x: Result<u32, &str> = Err("emergency failure");
assert_eq!(unsafe { x.unwrap_err_unchecked() }, "emergency failure");
```

### Response
#### Success Response (200)
N/A (Method on `Result` type)

#### Response Example
N/A (Method on `Result` type)
```

--------------------------------

### Test Case: is_candidate Functionality (Rust)

Source: https://docs.rs/id3/1.16.3/src/id3/v1v2

Tests the `is_candidate_path` function with various files, including one with both ID3v1 and ID3v2 tags, a JPG file, an ID3v1 only file, and an ID3v2 only file.

```Rust
#[test]
fn test_is_candidate() {
    let tmp = file_with_both_formats();
    assert_eq!(is_candidate_path(&tmp).unwrap(), FormatVersion::Both);
    assert_eq!(
        is_candidate_path("testdata/image.jpg").unwrap(),
        FormatVersion::None
    );
    assert_eq!(
        is_candidate_path("testdata/id3v1.id3").unwrap(),
        FormatVersion::Id3v1
    );
    assert_eq!(
        is_candidate_path("testdata/id3v24.id3").unwrap(),
        FormatVersion::Id3v2
    );
}
```

--------------------------------

### Read ID3v1 Tag from Path

Source: https://docs.rs/id3/1.16.3/src/id3/v1

Opens a file at the given path and reads the ID3v1 tag from it.

```APIDOC
## POST /read_id3v1_tag_from_path

### Description
Reads an ID3v1 tag from a file specified by its path.

### Method
POST

### Endpoint
/read_id3v1_tag_from_path

#### Request Body
- **path** (string) - Required - The path to the file.

### Request Example
```json
{
  "path": "/path/to/your/audiofile.mp3"
}
```

### Response
#### Success Response (200)
- **Tag** (object) - Contains the decoded ID3v1 tag information (same structure as above).

#### Response Example
```json
{
  "title": "Bohemian Rhapsody",
  "artist": "Queen",
  "album": "A Night at the Opera",
  "year": "1975",
  "comment": "A classic rock anthem",
  "track": 11,
  "genre_id": 3,
  "speed": null,
  "genre_str": null,
  "start_time": null,
  "end_time": null
}
```
```

--------------------------------

### Duration Metadata API

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

Manage the duration (TLEN) information within ID3 tags. Supports getting, setting, and removing the duration.

```APIDOC
## GET /api/tags/duration

### Description
Retrieves the duration (TLEN) information from the ID3 tag.

### Method
GET

### Endpoint
/api/tags/duration

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **duration** (integer) - The track duration in milliseconds.

#### Response Example
{
  "duration": 350
}

## POST /api/tags/duration

### Description
Sets the duration (TLEN) information in the ID3 tag.

### Method
POST

### Endpoint
/api/tags/duration

### Parameters
#### Request Body
- **duration** (integer) - Required - The track duration in milliseconds to set.

### Request Example
```json
{
  "duration": 400
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Duration set successfully."
}

## DELETE /api/tags/duration

### Description
Removes the duration (TLEN) information from the ID3 tag.

### Method
DELETE

### Endpoint
/api/tags/duration

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Duration removed successfully."
}
```

--------------------------------

### Tag Creation and Reading

Source: https://docs.rs/id3/1.16.3/id3/v1/struct

Provides methods for creating a new empty tag, checking for the presence of an ID3v1 tag in a reader, and reading tag data from a reader or a file path.

```APIDOC
## impl Tag

### Methods

#### `new()`
* **Description**: Creates a new empty ID3v1 tag.
* **Method**: `new()`
* **Returns**: `Tag`

#### `is_candidate(reader: impl Read + Seek)`
* **Description**: Checks whether the reader contains an ID3v1 tag. The reader position will be reset back to the previous position before returning.
* **Method**: `is_candidate`
* **Parameters**:
  * **reader** (impl Read + Seek) - The reader to check.
* **Returns**: `Result<bool>`

#### `read_from(reader: impl Read + Seek)`
* **Description**: Seeks to and reads a ID3v1 tag from the reader.
* **Method**: `read_from`
* **Parameters**:
  * **reader** (impl Read + Seek) - The reader to read from.
* **Returns**: `Result<Tag>`

#### `read_from_path(path: impl AsRef<Path>)`
* **Description**: Attempts to read an ID3v1 tag from the file at the indicated path.
* **Method**: `read_from_path`
* **Parameters**:
  * **path** (impl AsRef<Path>) - The path to the file.
* **Returns**: `Result<Tag>`
```

--------------------------------

### Title Metadata API

Source: https://docs.rs/id3/1.16.3/src/id3/taglike

Manage the title (TIT2) information within ID3 tags. Supports getting, setting, and removing the title.

```APIDOC
## GET /api/tags/title

### Description
Retrieves the title (TIT2) information from the ID3 tag.

### Method
GET

### Endpoint
/api/tags/title

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **title** (string) - The track title.

#### Response Example
{
  "title": "Example Title"
}

## POST /api/tags/title

### Description
Sets the title (TIT2) information in the ID3 tag.

### Method
POST

### Endpoint
/api/tags/title

### Parameters
#### Request Body
- **title** (string) - Required - The track title to set.

### Request Example
```json
{
  "title": "New Track Title"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Title set successfully."
}

## DELETE /api/tags/title

### Description
Removes the title (TIT2) information from the ID3 tag.

### Method
DELETE

### Endpoint
/api/tags/title

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Title removed successfully."
}
```

--------------------------------

### Create New ID3 Tag - Rust

Source: https://docs.rs/id3/1.16.3/index

Illustrates creating a new ID3 tag for an MP3 file, overwriting any existing tag. This example creates a new tag, sets the album title, and adds a frame explicitly, then writes it to the file using ID3v2.4.

```rust
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(())
}
```
Tokens:
Raw