Struct lofty::TaggedFile

pub struct TaggedFile { /* private fields */ }

A generic representation of a file

This is used when the FileType has to be guessed

Implementations

impl TaggedFile

pub fn file_type(&self) -> FileType

Returns the file’s FileType

Examples

use lofty::FileType;

let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert_eq!(tagged_file.file_type(), FileType::MPEG);

pub fn tags(&self) -> &[Tag]

Returns all tags

Examples

use lofty::FileType;

// An MP3 file with 3 tags
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

let tags = tagged_file.tags();

assert_eq!(tags.len(), 3);

pub fn primary_tag_type(&self) -> TagType

Returns the file type’s primary TagType

See FileType::primary_tag_type

Examples

use lofty::TagType;

let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert_eq!(tagged_file.primary_tag_type(), TagType::ID3v2);

pub fn supports_tag_type(&self, tag_type: TagType) -> bool

Determines whether the file supports the given TagType

Examples

use lofty::TagType;

let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert!(tagged_file.supports_tag_type(TagType::ID3v2));

pub fn tag(&self, tag_type: TagType) -> Option<&Tag>

Get a reference to a specific TagType

Examples

use lofty::TagType;

// Read an MP3 file with an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

// An ID3v2 tag
let tag = tagged_file.tag(TagType::ID3v2);

assert!(tag.is_some());
assert_eq!(tag.unwrap().tag_type(), TagType::ID3v2);

pub fn tag_mut(&mut self, tag_type: TagType) -> Option<&mut Tag>

Get a mutable reference to a specific TagType

Examples

use lofty::TagType;

// Read an MP3 file with an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

// An ID3v2 tag
let tag = tagged_file.tag(TagType::ID3v2);

assert!(tag.is_some());
assert_eq!(tag.unwrap().tag_type(), TagType::ID3v2);

// Alter the tag...

pub fn primary_tag(&self) -> Option<&Tag>

Returns the primary tag

See FileType::primary_tag_type

Examples

use lofty::TagType;

// Read an MP3 file with an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

// An ID3v2 tag
let tag = tagged_file.primary_tag();

assert!(tag.is_some());
assert_eq!(tag.unwrap().tag_type(), TagType::ID3v2);

pub fn primary_tag_mut(&mut self) -> Option<&mut Tag>

Gets a mutable reference to the file’s “Primary tag”

See FileType::primary_tag_type

Examples

use lofty::TagType;

// Read an MP3 file with an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

// An ID3v2 tag
let tag = tagged_file.primary_tag_mut();

assert!(tag.is_some());
assert_eq!(tag.unwrap().tag_type(), TagType::ID3v2);

// Alter the tag...

pub fn first_tag(&self) -> Option<&Tag>

Gets the first tag, if there are any

NOTE: This will grab the first available tag, you cannot rely on the result being a specific type

Examples

// A file we know has tags
let mut tagged_file = lofty::read_from_path(path)?;

// A tag of a (currently) unknown type
let tag = tagged_file.first_tag();
assert!(tag.is_some());

pub fn first_tag_mut(&mut self) -> Option<&mut Tag>

Gets a mutable reference to the first tag, if there are any

NOTE: This will grab the first available tag, you cannot rely on the result being a specific type

Examples

// A file we know has tags
let mut tagged_file = lofty::read_from_path(path)?;

// A tag of a (currently) unknown type
let tag = tagged_file.first_tag_mut();
assert!(tag.is_some());

// Alter the tag...

pub fn insert_tag(&mut self, tag: Tag) -> Option<Tag>

Inserts a Tag

NOTE: This will do nothing if the FileType does not support the TagType. See FileType::supports_tag_type

If a tag is replaced, it will be returned

Examples

use lofty::{AudioFile, Tag, TagType};

// Read an MP3 file without an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert!(!tagged_file.contains_tag_type(TagType::ID3v2));

// Insert the ID3v2 tag
let new_id3v2_tag = Tag::new(TagType::ID3v2);
tagged_file.insert_tag(new_id3v2_tag);

assert!(tagged_file.contains_tag_type(TagType::ID3v2));

pub fn take(&mut self, tag_type: TagType) -> Option<Tag>

Removes a specific TagType and returns it

Examples

use lofty::{AudioFile, TagType};

// Read an MP3 file containing an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert!(tagged_file.contains_tag_type(TagType::ID3v2));

// Take the ID3v2 tag
let id3v2 = tagged_file.take(TagType::ID3v2);

assert!(!tagged_file.contains_tag_type(TagType::ID3v2));

pub fn change_file_type(&mut self, file_type: FileType)

Changes the FileType

NOTES:

• This will remove any tag the format does not support. See FileType::supports_tag_type
• This will reset the FileProperties

Examples

use lofty::{AudioFile, FileType, TagType};

// Read an MP3 file containing an ID3v2 tag
let mut tagged_file = lofty::read_from_path(path_to_mp3)?;

assert!(tagged_file.contains_tag_type(TagType::ID3v2));

// Remap our MP3 file to WavPack, which doesn't support ID3v2
tagged_file.change_file_type(FileType::WavPack);

assert!(!tagged_file.contains_tag_type(TagType::ID3v2));

pub fn clear(&mut self)

Removes all tags from the file

Examples

let mut tagged_file = lofty::read_from_path(path)?;

tagged_file.clear();

assert!(tagged_file.tags().is_empty());

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

Attempts to write all tags to a path

Errors

See TaggedFile::save_to

Examples

let mut tagged_file = lofty::read_from_path(path)?;

// Edit the tags

tagged_file.save_to_path(path)?;

pub fn save_to(&self, file: &mut File) -> Result<()>

Attempts to write all tags to a file

Errors

See Tag::save_to, however this is applicable to every tag in the TaggedFile.

Examples

use std::fs::OpenOptions;

let mut tagged_file = lofty::read_from_path(path)?;

// Edit the tags

let mut file = OpenOptions::new().read(true).write(true).open(path)?;
tagged_file.save_to(&mut file)?;

Trait Implementations

impl AudioFile for TaggedFile

type Properties = FileProperties

The struct the file uses for audio properties

fn read_from<R>(reader: &mut R, parse_options: ParseOptions) -> Result<Self>where
    R: Read + Seek,
    Self: Sized,

Read a file from a reader

fn properties(&self) -> &Self::Properties

Returns a reference to the file’s properties

fn contains_tag(&self) -> bool

Checks if the file contains any tags

fn contains_tag_type(&self, tag_type: TagType) -> bool

Checks if the file contains the given TagType

impl From<AACFile> for TaggedFile

fn from(input: AACFile) -> Self

Converts to this type from the input type.

impl From<AiffFile> for TaggedFile

fn from(input: AiffFile) -> Self

Converts to this type from the input type.

impl From<ApeFile> for TaggedFile

fn from(input: ApeFile) -> Self

Converts to this type from the input type.

impl From<FlacFile> for TaggedFile

fn from(input: FlacFile) -> Self

Converts to this type from the input type.

impl From<MPEGFile> for TaggedFile

fn from(input: MPEGFile) -> Self

Converts to this type from the input type.

impl From<Mp4File> for TaggedFile

fn from(input: Mp4File) -> Self

Converts to this type from the input type.

impl From<OpusFile> for TaggedFile

fn from(input: OpusFile) -> Self

Converts to this type from the input type.

impl From<SpeexFile> for TaggedFile

fn from(input: SpeexFile) -> Self

Converts to this type from the input type.

impl From<VorbisFile> for TaggedFile

fn from(input: VorbisFile) -> Self

Converts to this type from the input type.

impl From<WavFile> for TaggedFile

fn from(input: WavFile) -> Self

Converts to this type from the input type.

impl From<WavPackFile> for TaggedFile

fn from(input: WavPackFile) -> Self

Converts to this type from the input type.