Struct Tag

pub struct Tag(/* private fields */);

An APE Tag containing APE Tag Items.

Examples

Creating a tag

use ape::{Item, ItemType, Tag, write_to_path};

let mut tag = Tag::new();
let item = Item::new("artist", ItemType::Text, "Artist Name").unwrap();
tag.set_item(item);
write_to_path(&tag, "path/to/file").unwrap();

Updating a tag

use ape::{Item, ItemType, read_from_path, write_to_path};

let path = "path/to/file";
let mut tag = read_from_path(path).unwrap();
let item = Item::new("album", ItemType::Text, "Album Name").unwrap();
tag.set_item(item);
tag.remove_items("cover");
write_to_path(&tag, path).unwrap();

Implementations

impl Tag

pub fn new() -> Tag

Creates a new empty tag.

pub fn item(&self, key: &str) -> Option<&Item>

Returns a first found item by key.

pub fn items(&self, key: &str) -> Vec<&Item>

Returns all items by key.

pub fn set_item(&mut self, item: Item)

Sets a new item.

If there is an item with the same key (case insensitive), it will be removed.

pub fn remove_items(&mut self, key: &str) -> usize

Removes all items by key.

Returns a number of deleted items

pub fn iter(&self) -> SliceIter<'_, Item>

Returns an iterator over the tag

Trait Implementations

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl IntoIterator for Tag

type Item = Item

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.