Struct lofty::TaggedFile

source · [−]

pub struct TaggedFile { /* private fields */ }

Expand description

A generic representation of a file

This is used when the FileType has to be guessed

Implementations

source

impl TaggedFile

source

pub fn file_type(&self) -> FileType

Returns the file’s FileType

source

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

Returns all tags

source

pub fn primary_tag_type(&self) -> TagType

Returns the file type’s primary TagType

See FileType::primary_tag_type

source

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

Determines whether the file supports the given TagType

source

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

Get a reference to a specific TagType

source

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

Get a mutable reference to a specific TagType

source

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

Returns the primary tag

See FileType::primary_tag_type

source

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

source

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

Gets the first tag, if there are any

source

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

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

source

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

source

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

Removes a specific TagType and returns it

source

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

source

pub fn clear(&mut self)

Removes all tags from the file

source

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

Attempts to write all tags to a path

Errors

See TaggedFile::save_to

source

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.

Trait Implementations

source

impl AudioFile for TaggedFile

type Properties = FileProperties

The struct the file uses for audio properties Read more

source

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

Read a file from a reader Read more

source

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

Returns a reference to the file’s properties

source

fn contains_tag(&self) -> bool

Checks if the file contains any tags

source

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

Checks if the file contains the given TagType

source