Struct SynchronizedTextFrame

pub struct SynchronizedTextFrame<'a> {
    pub encoding: TextEncoding,
    pub language: [u8; 3],
    pub timestamp_format: TimestampFormat,
    pub content_type: SyncTextContentType,
    pub description: Option<String>,
    pub content: Vec<(u32, String)>,
    /* private fields */
}

Represents an ID3v2 synchronized text frame

Fields

encoding: TextEncoding

The text encoding (description/text)

language: [u8; 3]

ISO-639-2 language code (3 bytes)

timestamp_format: TimestampFormat

The format of the timestamps

content_type: SyncTextContentType

The type of content stored

description: Option<String>

Unique content description

content: Vec<(u32, String)>

Collection of timestamps and text

Implementations

impl SynchronizedTextFrame<'_>

pub fn new( encoding: TextEncoding, language: [u8; 3], timestamp_format: TimestampFormat, content_type: SyncTextContentType, description: Option<String>, content: Vec<(u32, String)>, ) -> Self

Create a new SynchronizedTextFrame

pub fn id(&self) -> FrameId<'_>

Get the ID for the frame

pub fn flags(&self) -> FrameFlags

Get the flags for the frame

pub fn set_flags(&mut self, flags: FrameFlags)

Set the flags for the frame

pub fn parse(data: &[u8], frame_flags: FrameFlags) -> Result<Self>

Read a SynchronizedTextFrame from a slice

NOTE: This expects the frame header to have already been skipped

Errors

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

pub fn as_bytes(&self) -> Result<Vec<u8>>

Convert a SynchronizedTextFrame to an ID3v2 SYLT frame byte Vec

NOTE: This does not include the frame header

Errors

• content’s length > u32::MAX
• language is not exactly 3 bytes
• language contains invalid characters (Only 'a'..='z' and 'A'..='Z' allowed)

Trait Implementations

impl<'a> Clone for SynchronizedTextFrame<'a>

fn clone(&self) -> SynchronizedTextFrame<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SynchronizedTextFrame<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for SynchronizedTextFrame<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for SynchronizedTextFrame<'a>

fn eq(&self, other: &SynchronizedTextFrame<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for SynchronizedTextFrame<'a>

impl<'a> StructuralPartialEq for SynchronizedTextFrame<'a>