Struct lofty::ogg::VorbisComments

pub struct VorbisComments { /* private fields */ }

Vorbis comments

Implementations

impl VorbisComments

pub fn vendor(&self) -> &str

Returns the vendor string

pub fn set_vendor(&mut self, vendor: String)

Sets the vendor string

pub fn items(&self) -> &[(String, String)]

Returns the tag’s items in (key, value) pairs

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

Gets an item by key

NOTE: This is case-sensitive

pub fn insert_item(&mut self, key: String, value: String, replace_all: bool)

Inserts an item

If replace_all is true, it will remove all items with the key before insertion

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

Removes an item by key

NOTE: This is case-sensitive

pub fn insert_picture(
    &mut self,
    picture: Picture
) -> Result<Option<(Picture, PictureInformation)>>

Inserts a Picture

According to spec, there can only be one picture of type PictureType::Icon and PictureType::OtherIcon. When attempting to insert these types, if another is found it will be removed and returned.

Errors

• See PictureInformation::from_picture

pub fn remove_picture_type(&mut self, picture_type: PictureType)

Removes a certain PictureType

Trait Implementations

impl Accessor for VorbisComments

fn artist(&self) -> Option<&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<&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<&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<&str>

Returns the genre

fn set_genre(&mut self, value: String)

Sets the genre

fn remove_genre(&mut self)

Removes the genre

impl Clone for VorbisComments

fn clone(&self) -> VorbisComments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VorbisComments

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

Formats the value using the given formatter.

impl Default for VorbisComments

fn default() -> VorbisComments

Returns the “default value” for a type.

impl From<Tag> for VorbisComments

fn from(input: Tag) -> Self

Performs the conversion.

impl From<VorbisComments> for Tag

fn from(input: VorbisComments) -> Self

Performs the conversion.

impl PartialEq<VorbisComments> for VorbisComments

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

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

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

This method tests for !=.

impl TagExt for VorbisComments

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

Writes the tag to a path

Errors

• path does not exist
• See VorbisComments::save_to

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

Writes the tag to a file

Errors

• Attempting to write the tag to a format that does not support it
• The file does not contain valid packets
• PictureInformation::from_picture
• std::io::Error

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

Dumps the tag to a writer

This does not include a vendor string, and will thus not create a usable file.

Errors

• PictureInformation::from_picture
• std::io::Error

type Err = LoftyError

The associated error which can be returned from IO operations

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

impl StructuralPartialEq for VorbisComments