Struct id3::frame::Chapter

pub struct Chapter {
    pub element_id: String,
    pub start_time: u32,
    pub end_time: u32,
    pub start_offset: u32,
    pub end_offset: u32,
    pub frames: Vec<Frame>,
}

Fields

element_id: String

start_time: u32

end_time: u32

start_offset: u32

end_offset: u32

frames: Vec<Frame>

Trait Implementations

impl Clone for Chapter

fn clone(&self) -> Chapter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chapter

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

Formats the value using the given formatter.

impl Display for Chapter

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

Formats the value using the given formatter.

impl Extend<Frame> for Chapter

fn extend<I: IntoIterator<Item = Frame>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Chapter> for Frame

fn from(c: Chapter) -> Self

Performs the conversion.

impl Hash for Chapter

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 Ord for Chapter

fn cmp(&self, other: &Chapter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Chapter> for Chapter

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

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

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

This method tests for !=.

impl PartialOrd<Chapter> for Chapter

fn partial_cmp(&self, other: &Chapter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TagLike for Chapter

fn get(&self, id: impl AsRef<str>) -> Option<&Frame>

Returns a reference to the first frame with the specified identifier.

fn add_frame(&mut self, new_frame: impl Into<Frame>) -> Option<Frame>

Adds the frame to the tag, replacing and returning any conflicting frame.

fn set_text(&mut self, id: impl AsRef<str>, text: impl Into<String>)

Adds a text frame.

fn set_text_values(
    &mut self,
    id: impl AsRef<str>,
    texts: impl IntoIterator<Item = impl Into<String>>
)

Panics

fn remove(&mut self, id: impl AsRef<str>) -> Vec<Frame>

Remove all frames with the specified identifier and return them.

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

Returns the year (TYER). Returns None if the year frame could not be found or if it could not be parsed.

fn set_year(&mut self, year: i32)

Sets the year (TYER).

fn remove_year(&mut self)

Removes the year (TYER).

fn date_recorded(&self) -> Option<Timestamp>

Return the content of the TRDC frame, if any

fn set_date_recorded(&mut self, timestamp: Timestamp)

Sets the content of the TDRC frame

fn remove_date_recorded(&mut self)

Remove the content of the TDRC frame

fn date_released(&self) -> Option<Timestamp>

Return the content of the TDRL frame, if any

fn set_date_released(&mut self, timestamp: Timestamp)

Sets the content of the TDRL frame

fn remove_date_released(&mut self)

Remove the content of the TDRL frame

fn artist(&self) -> Option<&str>

Returns the artist (TPE1).

fn set_artist(&mut self, artist: impl Into<String>)

Sets the artist (TPE1).

fn remove_artist(&mut self)

Removes the artist (TPE1).

fn album_artist(&self) -> Option<&str>

Sets the album artist (TPE2).

fn set_album_artist(&mut self, album_artist: impl Into<String>)

Sets the album artist (TPE2).

fn remove_album_artist(&mut self)

Removes the album artist (TPE2).

fn album(&self) -> Option<&str>

Returns the album (TALB).

fn set_album(&mut self, album: impl Into<String>)

Sets the album (TALB).

fn remove_album(&mut self)

Removes the album (TALB).

fn title(&self) -> Option<&str>

Returns the title (TIT2).

fn set_title(&mut self, title: impl Into<String>)

Sets the title (TIT2).

fn remove_title(&mut self)

Removes the title (TIT2).

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

Returns the duration (TLEN).

fn set_duration(&mut self, duration: u32)

Sets the duration (TLEN).

fn remove_duration(&mut self)

Removes the duration (TLEN).

fn genre(&self) -> Option<&str>

Returns the genre (TCON).

fn set_genre(&mut self, genre: impl Into<String>)

Sets the genre (TCON).

fn remove_genre(&mut self)

Removes the genre (TCON).

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

Returns the disc number (TPOS).

fn set_disc(&mut self, disc: u32)

Sets the disc (TPOS).

fn remove_disc(&mut self)

Removes the disc number (TPOS).

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

Returns the total number of discs (TPOS).

fn set_total_discs(&mut self, total_discs: u32)

Sets the total number of discs (TPOS).

fn remove_total_discs(&mut self)

Removes the total number of discs (TPOS).

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

Returns the track number (TRCK).

fn set_track(&mut self, track: u32)

Sets the track (TRCK).

fn remove_track(&mut self)

Removes the track number (TRCK).

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

Returns the total number of tracks (TRCK).

fn set_total_tracks(&mut self, total_tracks: u32)

Sets the total number of tracks (TRCK).

fn remove_total_tracks(&mut self)

Removes the total number of tracks (TCON).

fn add_extended_text(
    &mut self,
    description: impl Into<String>,
    value: impl Into<String>
)

👎 Deprecated:

Use add_frame(frame::ExtendedText{ .. })

Adds a user defined text frame (TXXX).

fn remove_extended_text(
    &mut self,
    description: Option<&str>,
    value: Option<&str>
)

Removes the user defined text frame (TXXX) with the specified key and value.

fn add_picture(&mut self, picture: Picture)

👎 Deprecated:

Use add_frame(frame::Picture{ .. })

Adds a picture frame (APIC). Any other pictures with the same type will be removed from the tag.

fn remove_picture_by_type(&mut self, picture_type: PictureType)

Removes all pictures of the specified type.

fn remove_all_pictures(&mut self)

Removes all pictures.

fn add_comment(&mut self, comment: Comment)

👎 Deprecated:

Use add_frame(frame::Comment{ .. })

Adds a comment (COMM).

fn remove_comment(&mut self, description: Option<&str>, text: Option<&str>)

Removes the comment (COMM) with the specified key and value.

fn add_encapsulated_object(
    &mut self,
    description: impl Into<String>,
    mime_type: impl Into<String>,
    filename: impl Into<String>,
    data: impl Into<Vec<u8>>
)

👎 Deprecated:

Use add_frame(frame::EncapsulatedObject{ .. })

Adds an encapsulated object frame (GEOB).

fn remove_encapsulated_object(
    &mut self,
    description: Option<&str>,
    mime_type: Option<&str>,
    filename: Option<&str>,
    data: Option<&[u8]>
)

Removes the encapsulated object frame (GEOB) with the specified key, MIME type, filename and data.

fn add_lyrics(&mut self, lyrics: Lyrics)

👎 Deprecated:

Use add_frame(frame::Lyrics{ .. })

Sets the lyrics (USLT).

fn remove_all_lyrics(&mut self)

Removes the lyrics text (USLT) from the tag.

fn add_synchronised_lyrics(&mut self, lyrics: SynchronisedLyrics)

👎 Deprecated:

Use add_frame(frame::SynchronisedLyrics{ .. })

Adds a synchronised lyrics frame (SYLT).

fn remove_all_synchronised_lyrics(&mut self)

Removes all synchronised lyrics (SYLT) frames from the tag.

fn remove_all_chapters(&mut self)

Adds a single chapter (CHAP) to the farme.

impl Eq for Chapter

impl StructuralEq for Chapter

impl StructuralPartialEq for Chapter