Struct id3::Tag

Attempts to write the ID3 tag from the file at the indicated path. If the specified path is the same path which the tag was read from, then the tag will be written to the padding if possible.

source

pub fn write_to_path( &self, path: impl AsRef<Path>, version: Version ) -> Result<()>

Conventience function for [write_to_file].

source

pub fn write_to_aiff_path( &self, path: impl AsRef<Path>, version: Version ) -> Result<()>

👎Deprecated: use write_to_path

Overwrite WAV file ID3 chunk in a file

source

pub fn write_to_aiff_file( &self, file: impl StorageFile, version: Version ) -> Result<()>

👎Deprecated: use write_to_file

Overwrite AIFF file ID3 chunk in a file. The file must be opened read/write.

source

pub fn write_to_wav_path( &self, path: impl AsRef<Path>, version: Version ) -> Result<()>

👎Deprecated: use write_to_path

Overwrite WAV file ID3 chunk

source

pub fn write_to_wav_file( &self, file: impl StorageFile, version: Version ) -> Result<()>

👎Deprecated: use write_to_file

Overwrite AIFF file ID3 chunk in a file. The file must be opened read/write.

source

pub fn version(&self) -> Version

Returns version of the read tag.

source

pub fn frames(&'a self) -> impl Iterator<Item = &'a Frame> + 'a

Returns an iterator over the all frames in the tag.

§Example

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

let mut tag = Tag::new();

tag.add_frame(Frame::with_content("TPE1", Content::Text("".to_string())));
tag.add_frame(Frame::with_content("APIC", Content::Text("".to_string())));

assert_eq!(tag.frames().count(), 2);

source

pub fn extended_texts(&'a self) -> impl Iterator<Item = &'a ExtendedText> + 'a

Returns an iterator over the extended texts in the tag.

source

pub fn extended_links(&'a self) -> impl Iterator<Item = &'a ExtendedLink> + 'a

Returns an iterator over the extended links in the tag.

source

pub fn encapsulated_objects( &'a self ) -> impl Iterator<Item = &'a EncapsulatedObject> + 'a

Returns an iterator over the General Encapsulated Object (GEOB) frames in the tag.

source

pub fn comments(&'a self) -> impl Iterator<Item = &'a Comment> + 'a

Returns an iterator over the comments in the tag.

§Example

use id3::{Frame, Tag, TagLike};
use id3::frame::{Content, Comment};

let mut tag = Tag::new();

let frame = Frame::with_content("COMM", Content::Comment(Comment {
    lang: "eng".to_owned(),
    description: "key1".to_owned(),
    text: "value1".to_owned()
}));
tag.add_frame(frame);

let frame = Frame::with_content("COMM", Content::Comment(Comment {
    lang: "eng".to_owned(),
    description: "key2".to_owned(),
    text: "value2".to_owned()
}));
tag.add_frame(frame);

assert_eq!(tag.comments().count(), 2);

source

pub fn lyrics(&'a self) -> impl Iterator<Item = &'a Lyrics> + 'a

Returns an iterator over the lyrics frames in the tag.

source

pub fn synchronised_lyrics( &'a self ) -> impl Iterator<Item = &'a SynchronisedLyrics> + 'a

Returns an iterator over the synchronised lyrics frames in the tag.

source

pub fn pictures(&'a self) -> impl Iterator<Item = &'a Picture> + 'a

Returns an iterator over the pictures in the tag.

§Example

use id3::{Frame, Tag, TagLike};
use id3::frame::{Content, Picture, PictureType};

let mut tag = Tag::new();

let picture = Picture {
    mime_type: String::new(),
    picture_type: PictureType::Other,
    description: String::new(),
    data: Vec::new(),
};
tag.add_frame(Frame::with_content("APIC", Content::Picture(picture.clone())));
tag.add_frame(Frame::with_content("APIC", Content::Picture(picture.clone())));

assert_eq!(tag.pictures().count(), 1);

source

pub fn chapters(&self) -> impl Iterator<Item = &Chapter>

Returns an iterator over all chapters (CHAP) in the tag.

§Example

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

let mut tag = Tag::new();
tag.add_frame(Chapter{
    element_id: "01".to_string(),
    start_time: 1000,
    end_time: 2000,
    start_offset: 0xff,
    end_offset: 0xff,
    frames: Vec::new(),
});
tag.add_frame(Chapter{
    element_id: "02".to_string(),
    start_time: 2000,
    end_time: 3000,
    start_offset: 0xff,
    end_offset: 0xff,
    frames: Vec::new(),
});
assert_eq!(2, tag.chapters().count());

source

pub fn tables_of_contents(&self) -> impl Iterator<Item = &TableOfContents>

Returns an iterator over all tables of contents (CTOC) in the tag.

§Example

use id3::{Tag, TagLike};
use id3::frame::{Chapter, TableOfContents, Content, Frame};

let mut tag = Tag::new();
tag.add_frame(Chapter{
    element_id: "chap01".to_string(),
    start_time: 1000,
    end_time: 2000,
    start_offset: 0xff,
    end_offset: 0xff,
    frames: Vec::new(),
});
tag.add_frame(TableOfContents{
    element_id: "internalTable01".to_string(),
    top_level: false,
    ordered: false,
    elements: Vec::new(),
    frames: Vec::new(),
});
tag.add_frame(TableOfContents{
    element_id: "01".to_string(),
    top_level: true,
    ordered: true,
    elements: vec!["internalTable01".to_string(),"chap01".to_string()],
    frames: Vec::new(),
});
assert_eq!(2, tag.tables_of_contents().count());