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 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, TaggedFileExt};

// 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));

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 save_to(&self, file: &mut File) -> Result<()>

Attempts to write all tags to a file

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

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

Attempts to write all tags to a path

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<BoundTaggedFile> for TaggedFile

fn from(input: BoundTaggedFile) -> Self

Converts to this type from the input type.

impl From<FlacFile> for TaggedFile

fn from(value: FlacFile) -> 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<MpcFile> for TaggedFile

fn from(input: MpcFile) -> 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<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.

impl TaggedFileExt for TaggedFile

fn file_type(&self) -> FileType

Returns the file’s FileType

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

Returns all tags

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

Get a reference to a specific TagType

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

Get a mutable reference to a specific TagType

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

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

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

Inserts a Tag

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

Removes a specific TagType and returns it

fn clear(&mut self)

Removes all tags from the file

fn primary_tag_type(&self) -> TagType

Returns the file type’s primary TagType

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

Determines whether the file supports the given TagType

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

Returns the primary tag

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

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

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

Gets the first tag, if there are any