Struct lofty::Picture

pub struct Picture { /* private fields */ }

Represents a picture.

Implementations

impl Picture

pub fn from_reader<R>(reader: &mut R) -> Result<Self> where
    R: Read, 

Create a Picture from a reader

NOTES:

• This is for reading picture data only, from a File for example.
• pic_type will always be PictureType::Other, be sure to change it accordingly if writing.

Errors

• reader contains less than 8 bytes
• reader does not contain a supported format. See MimeType for valid formats

pub fn new_unchecked(
    pic_type: PictureType,
    mime_type: MimeType,
    description: Option<String>,
    data: Vec<u8>
) -> Self

Create a new Picture

NOTE: This will not verify data’s signature. This should only be used if all data has been verified beforehand.

pub fn pic_type(&self) -> PictureType

Returns the PictureType

pub fn set_pic_type(&mut self, pic_type: PictureType)

Sets the PictureType

pub fn mime_type(&self) -> &MimeType

Returns the MimeType

The mime_type is determined from the data, and is immutable.

pub fn description(&self) -> Option<&str>

Returns the description

pub fn set_description(&mut self, description: Option<String>)

Sets the description

pub fn data(&self) -> &[u8]

Returns the picture data

pub fn as_apic_bytes(
    &self,
    version: Id3v2Version,
    text_encoding: TextEncoding
) -> Result<Vec<u8>>

This is supported on crate feature id3v2 only.

Convert a Picture to a ID3v2 A/PIC byte Vec

NOTE: This does not include the frame header

Errors

• Too much data was provided

ID3v2.2:

• The mimetype is not MimeType::Png or MimeType::Jpeg

pub fn from_apic_bytes(
    bytes: &[u8],
    version: Id3v2Version
) -> Result<(Self, TextEncoding)>

This is supported on crate feature id3v2 only.

Get a Picture and TextEncoding from ID3v2 A/PIC bytes:

NOTE: This expects only the frame content

Errors

• There isn’t enough data present
• The data isn’t a picture

ID3v2.2:

• The format is not “PNG” or “JPG”

pub fn as_flac_bytes(
    &self,
    picture_information: PictureInformation,
    encode: bool
) -> Vec<u8>

This is supported on crate feature vorbis_comments only.

Convert a Picture to a base64 encoded FLAC METADATA_BLOCK_PICTURE String

Use encode to convert the picture to a base64 encoded String (RFC 4648 §4)

NOTES:

• This does not include a key (Vorbis comments) or METADATA_BLOCK_HEADER (FLAC blocks)
• FLAC blocks have different size requirements than OGG Vorbis/Opus, size is not checked here
• When writing to Vorbis comments, the data must be base64 encoded

pub fn from_flac_bytes(
    bytes: &[u8],
    encoded: bool
) -> Result<(Self, PictureInformation)>

This is supported on crate feature vorbis_comments only.

Get a Picture from FLAC METADATA_BLOCK_PICTURE bytes:

NOTE: This takes both the base64 encoded string from Vorbis comments, and the raw data from a FLAC block, specified with encoded.

Errors

This function will return NotAPicture if at any point it’s unable to parse the data

pub fn as_ape_bytes(&self) -> Vec<u8>

This is supported on crate feature ape only.

Convert a Picture to an APE Cover Art byte vec:

NOTE: This is only the picture data and description, a key and terminating null byte will not be prepended. To map a PictureType to an APE key see PictureType::as_ape_key

pub fn from_ape_bytes(key: &str, bytes: &[u8]) -> Result<Self>

This is supported on crate feature ape only.

Get a Picture from an APEv2 binary item:

NOTE: This function expects bytes to contain only the APE item data

Errors

This function will return NotAPicture if at any point it’s unable to parse the data

Trait Implementations

impl Clone for Picture

fn clone(&self) -> Picture

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Picture

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

Formats the value using the given formatter.

impl Hash for Picture

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Picture> for Picture

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

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

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

This method tests for !=.

impl Eq for Picture

impl StructuralEq for Picture

impl StructuralPartialEq for Picture