Struct lofty::ape::ApeTag

pub struct ApeTag {
    pub read_only: bool,
    /* private fields */
}

An APE tag

Supported file types

• FileType::Ape
• FileType::Mpeg
• FileType::Mpc
• FileType::WavPack

Item storage

APE isn’t a very strict format. An ApeItem only restricted by its name, meaning it can use a normal ItemValue unlike other formats.

Pictures are stored as ItemValue::Binary, and can be converted with Picture::from_ape_bytes. For the appropriate item keys, see APE_PICTURE_TYPES.

Conversions

To Tag

Any ApeItem with an ItemKey mapping will have a 1:1 conversion to TagItem.

From Tag

When converting pictures, any of type PictureType::Undefined will be discarded. For items, see ApeItem::new.

Fields

read_only: bool

Whether or not to mark the tag as read only

Implementations

impl ApeTag

pub fn new() -> Self

Create a new empty ApeTag

Examples

use lofty::ape::ApeTag;
use lofty::TagExt;

let ape_tag = ApeTag::new();
assert!(ape_tag.is_empty());

pub fn get(&self, key: &str) -> Option<&ApeItem>

Get an ApeItem by key

NOTE: While APE items are supposed to be case-sensitive, this rule is rarely followed, so this will ignore case when searching.

Examples

use lofty::ape::ApeTag;
use lofty::Accessor;

let mut ape_tag = ApeTag::new();
ape_tag.set_title(String::from("Foo title"));

// Get the title by its key
let title = ape_tag.get("Title");
assert!(title.is_some());

pub fn insert(&mut self, value: ApeItem)

Insert an ApeItem

This will remove any item with the same key prior to insertion

pub fn remove(&mut self, key: &str)

Remove an ApeItem by key

NOTE: Like ApeTag::get, this is not case-sensitive

Examples

use lofty::ape::ApeTag;
use lofty::Accessor;

let mut ape_tag = ApeTag::new();
ape_tag.set_title(String::from("Foo title"));

// Get the title by its key
let title = ape_tag.get("Title");
assert!(title.is_some());

// Remove the title
ape_tag.remove("Title");

let title = ape_tag.get("Title");
assert!(title.is_none());

Trait Implementations

impl Accessor for ApeTag

fn artist(&self) -> Option<Cow<'_, str>>

Returns the artist

fn set_artist(&mut self, value: String)

Sets the artist

fn remove_artist(&mut self)

Removes the artist

fn title(&self) -> Option<Cow<'_, str>>

Returns the title

fn set_title(&mut self, value: String)

Sets the title

fn remove_title(&mut self)

Removes the title

fn album(&self) -> Option<Cow<'_, str>>

Returns the album

fn set_album(&mut self, value: String)

Sets the album

fn remove_album(&mut self)

Removes the album

fn genre(&self) -> Option<Cow<'_, str>>

Returns the genre

fn set_genre(&mut self, value: String)

Sets the genre

fn remove_genre(&mut self)

Removes the genre

fn comment(&self) -> Option<Cow<'_, str>>

Returns the comment

fn set_comment(&mut self, value: String)

Sets the comment

fn remove_comment(&mut self)

Removes the comment

fn track(&self) -> Option<u32>

Returns the track

fn set_track(&mut self, value: u32)

Sets the track

fn remove_track(&mut self)

Removes the track

fn track_total(&self) -> Option<u32>

Returns the track total

fn set_track_total(&mut self, value: u32)

Sets the track total

fn remove_track_total(&mut self)

Removes the track total

fn disk(&self) -> Option<u32>

Returns the disk

fn set_disk(&mut self, value: u32)

Sets the disk

fn remove_disk(&mut self)

Removes the disk

fn disk_total(&self) -> Option<u32>

Returns the disk total

fn set_disk_total(&mut self, value: u32)

Sets the disk total

fn remove_disk_total(&mut self)

Removes the disk total

fn year(&self) -> Option<u32>

Returns the year

fn set_year(&mut self, value: u32)

Sets the year

fn remove_year(&mut self)

Removes the year

impl Clone for ApeTag

fn clone(&self) -> ApeTag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApeTag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApeTag

fn default() -> ApeTag

Returns the “default value” for a type.

impl From<ApeTag> for Tag

fn from(input: ApeTag) -> Self

Converts to this type from the input type.

impl From<Tag> for ApeTag

fn from(input: Tag) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a ApeTag

type Item = &'a ApeItem

The type of the elements being iterated over.

type IntoIter = Iter<'a, ApeItem>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ApeTag

type Item = ApeItem

The type of the elements being iterated over.

type IntoIter = IntoIter<<ApeTag as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ApeTag

fn eq(&self, other: &ApeTag) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SplitTag for ApeTag

type Remainder = SplitTagRemainder

The remainder of the split operation that is not represented in the resulting Tag.

fn split_tag(self) -> (Self::Remainder, Tag)

Extract and split generic contents into a Tag.

impl TagExt for ApeTag

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

Write an APE tag to a file

Errors

• Attempting to write the tag to a format that does not support it
• An existing tag has an invalid size

fn dump_to<W: Write>(&self, writer: &mut W) -> Result<(), Self::Err>

Dumps the tag to a writer

Errors

• std::io::Error

type Err = LoftyError

The associated error which can be returned from IO operations

type RefKey<'a> = &'a str

The type of key used in the tag for non-mutating functions

fn len(&self) -> usize

Returns the number of items in the tag

fn contains<'a>(&'a self, key: Self::RefKey<'a>) -> bool

Whether the tag contains an item with the key

fn is_empty(&self) -> bool

Whether the tag has any items

fn remove_from_path<P: AsRef<Path>>(&self, path: P) -> Result<(), Self::Err>

Remove a tag from a Path

fn remove_from(&self, file: &mut File) -> Result<(), Self::Err>

Remove a tag from a File

fn clear(&mut self)

Clear the tag, removing all items

fn save_to_path<P: AsRef<Path>>(&self, path: P) -> Result<(), Self::Err>

Save the tag to a path

impl Eq for ApeTag

impl StructuralEq for ApeTag

impl StructuralPartialEq for ApeTag