Struct lofty::TaggedFile

pub struct TaggedFile { /* fields omitted */ }

A generic representation of a file

This is used when the FileType has to be guessed

Implementations

impl TaggedFile

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

Returns the primary tag

See FileType::primary_tag_type

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

pub fn primary_tag_type(&self) -> TagType

Returns the file type’s primary TagType

See FileType::primary_tag_type

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

Determines whether the file supports the given TagType

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

Returns all tags

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

Gets the first tag, if there are any

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

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

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

Get a reference to a specific TagType

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

Get a mutable reference to a specific TagType

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

Inserts a Tag

If a tag is replaced, it will be returned

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

Removes a specific TagType

This will return the tag if it is removed

pub fn clear(&mut self)

Removes all tags from the file

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

Attempts to write all tags to a path

Errors

See TaggedFile::save_to

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.

impl TaggedFile

pub fn file_type(&self) -> &FileType

Returns the file’s FileType

pub fn properties(&self) -> &FileProperties

Returns a reference to the file’s FileProperties

Trait Implementations

impl From<AiffFile> for TaggedFile

fn from(input: AiffFile) -> Self

Performs the conversion.

impl From<ApeFile> for TaggedFile

fn from(input: ApeFile) -> Self

Performs the conversion.

impl From<FlacFile> for TaggedFile

fn from(input: FlacFile) -> Self

Performs the conversion.

impl From<Mp3File> for TaggedFile

fn from(input: Mp3File) -> Self

Performs the conversion.

impl From<Mp4File> for TaggedFile

fn from(input: Mp4File) -> Self

Performs the conversion.

impl From<OpusFile> for TaggedFile

fn from(input: OpusFile) -> Self

Performs the conversion.

impl From<VorbisFile> for TaggedFile

fn from(input: VorbisFile) -> Self

Performs the conversion.

impl From<WavFile> for TaggedFile

fn from(input: WavFile) -> Self

Performs the conversion.