Struct id3::frame::TableOfContents
source · pub struct TableOfContents {
pub element_id: String,
pub top_level: bool,
pub ordered: bool,
pub elements: Vec<String>,
pub frames: Vec<Frame>,
}
Fields§
§element_id: String
§top_level: bool
§ordered: bool
§elements: Vec<String>
§frames: Vec<Frame>
Trait Implementations§
source§impl Clone for TableOfContents
impl Clone for TableOfContents
source§fn clone(&self) -> TableOfContents
fn clone(&self) -> TableOfContents
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TableOfContents
impl Debug for TableOfContents
source§impl Display for TableOfContents
impl Display for TableOfContents
source§impl Extend<Frame> for TableOfContents
impl Extend<Frame> for TableOfContents
source§fn extend<I: IntoIterator<Item = Frame>>(&mut self, iter: I)
fn extend<I: IntoIterator<Item = Frame>>(&mut self, iter: I)
Extends a collection with the contents of an iterator. Read more
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
🔬This is a nightly-only experimental API. (
extend_one
)Extends a collection with exactly one element.
source§fn extend_reserve(&mut self, additional: usize)
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. Read more
source§impl From<TableOfContents> for Frame
impl From<TableOfContents> for Frame
source§fn from(c: TableOfContents) -> Self
fn from(c: TableOfContents) -> Self
Converts to this type from the input type.
source§impl Hash for TableOfContents
impl Hash for TableOfContents
source§impl Ord for TableOfContents
impl Ord for TableOfContents
source§fn cmp(&self, other: &TableOfContents) -> Ordering
fn cmp(&self, other: &TableOfContents) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl PartialEq for TableOfContents
impl PartialEq for TableOfContents
source§fn eq(&self, other: &TableOfContents) -> bool
fn eq(&self, other: &TableOfContents) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for TableOfContents
impl PartialOrd for TableOfContents
source§fn partial_cmp(&self, other: &TableOfContents) -> Option<Ordering>
fn partial_cmp(&self, other: &TableOfContents) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moresource§impl TagLike for TableOfContents
impl TagLike for TableOfContents
source§fn get(&self, id: impl AsRef<str>) -> Option<&Frame>
fn get(&self, id: impl AsRef<str>) -> Option<&Frame>
Returns a reference to the first frame with the specified identifier. Read more
source§fn add_frame(&mut self, new_frame: impl Into<Frame>) -> Option<Frame>
fn add_frame(&mut self, new_frame: impl Into<Frame>) -> Option<Frame>
Adds the frame to the tag, replacing and returning any conflicting frame. Read more
source§fn set_text(&mut self, id: impl AsRef<str>, text: impl Into<String>)
fn set_text(&mut self, id: impl AsRef<str>, text: impl Into<String>)
Adds a text frame. Read more
source§fn set_text_values(
&mut self,
id: impl AsRef<str>,
texts: impl IntoIterator<Item = impl Into<String>>
)
fn set_text_values( &mut self, id: impl AsRef<str>, texts: impl IntoIterator<Item = impl Into<String>> )
Panics Read more
source§fn remove(&mut self, id: impl AsRef<str>) -> Vec<Frame>
fn remove(&mut self, id: impl AsRef<str>) -> Vec<Frame>
Remove all frames with the specified identifier and return them. Read more
source§fn year(&self) -> Option<i32>
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. Read moresource§fn remove_year(&mut self)
fn remove_year(&mut self)
Removes the year (TYER). Read more
source§fn date_recorded(&self) -> Option<Timestamp>
fn date_recorded(&self) -> Option<Timestamp>
Return the content of the TRDC frame, if any Read more
source§fn set_date_recorded(&mut self, timestamp: Timestamp)
fn set_date_recorded(&mut self, timestamp: Timestamp)
Sets the content of the TDRC frame Read more
source§fn remove_date_recorded(&mut self)
fn remove_date_recorded(&mut self)
Remove the content of the TDRC frame Read more
source§fn date_released(&self) -> Option<Timestamp>
fn date_released(&self) -> Option<Timestamp>
Return the content of the TDRL frame, if any Read more
source§fn set_date_released(&mut self, timestamp: Timestamp)
fn set_date_released(&mut self, timestamp: Timestamp)
Sets the content of the TDRL frame Read more
source§fn remove_date_released(&mut self)
fn remove_date_released(&mut self)
Remove the content of the TDRL frame Read more
source§fn original_date_released(&self) -> Option<Timestamp>
fn original_date_released(&self) -> Option<Timestamp>
Return the content of the TDOR frame, if any Read more
source§fn set_original_date_released(&mut self, timestamp: Timestamp)
fn set_original_date_released(&mut self, timestamp: Timestamp)
Sets the content of the TDOR frame Read more
source§fn remove_original_date_released(&mut self)
fn remove_original_date_released(&mut self)
Remove the content of the TDOR frame Read more
source§fn remove_artist(&mut self)
fn remove_artist(&mut self)
Removes the artist (TPE1). Read more
source§fn set_album_artist(&mut self, album_artist: impl Into<String>)
fn set_album_artist(&mut self, album_artist: impl Into<String>)
Sets the album artist (TPE2). Read more
source§fn remove_album_artist(&mut self)
fn remove_album_artist(&mut self)
Removes the album artist (TPE2). Read more
source§fn remove_album(&mut self)
fn remove_album(&mut self)
Removes the album (TALB). Read more
source§fn remove_title(&mut self)
fn remove_title(&mut self)
Removes the title (TIT2). Read more
source§fn set_duration(&mut self, duration: u32)
fn set_duration(&mut self, duration: u32)
Sets the duration (TLEN). Read more
source§fn remove_duration(&mut self)
fn remove_duration(&mut self)
Removes the duration (TLEN). Read more
source§fn genre_parsed(&self) -> Option<Cow<'_, str>>
fn genre_parsed(&self) -> Option<Cow<'_, str>>
Returns the genre (TCON) with ID3v1 genre indices resolved. Read more
source§fn remove_genre(&mut self)
fn remove_genre(&mut self)
Removes the genre (TCON). Read more
source§fn remove_disc(&mut self)
fn remove_disc(&mut self)
Removes the disc number (TPOS). Read more
source§fn set_total_discs(&mut self, total_discs: u32)
fn set_total_discs(&mut self, total_discs: u32)
Sets the total number of discs (TPOS). Read more
source§fn remove_total_discs(&mut self)
fn remove_total_discs(&mut self)
Removes the total number of discs (TPOS). Read more
source§fn remove_track(&mut self)
fn remove_track(&mut self)
Removes the track number (TRCK). Read more
source§fn set_total_tracks(&mut self, total_tracks: u32)
fn set_total_tracks(&mut self, total_tracks: u32)
Sets the total number of tracks (TRCK). Read more
source§fn remove_total_tracks(&mut self)
fn remove_total_tracks(&mut self)
Removes the total number of tracks (TCON). Read more
source§fn add_extended_text(
&mut self,
description: impl Into<String>,
value: impl Into<String>
)
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). Read more
source§fn remove_extended_text(
&mut self,
description: Option<&str>,
value: Option<&str>
)
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. Read more
source§fn add_picture(&mut self, picture: Picture)
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. Read more
source§fn remove_picture_by_type(&mut self, picture_type: PictureType)
fn remove_picture_by_type(&mut self, picture_type: PictureType)
Removes all pictures of the specified type. Read more
source§fn remove_all_pictures(&mut self)
fn remove_all_pictures(&mut self)
Removes all pictures. Read more
source§fn add_comment(&mut self, comment: Comment)
fn add_comment(&mut self, comment: Comment)
👎Deprecated: Use add_frame(frame::Comment{ .. })
Adds a comment (COMM). Read more
source§fn remove_comment(&mut self, description: Option<&str>, text: Option<&str>)
fn remove_comment(&mut self, description: Option<&str>, text: Option<&str>)
Removes the comment (COMM) with the specified key and value. Read more
source§fn add_encapsulated_object(
&mut self,
description: impl Into<String>,
mime_type: impl Into<String>,
filename: impl Into<String>,
data: impl Into<Vec<u8>>
)
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). Read more
source§fn remove_encapsulated_object(
&mut self,
description: Option<&str>,
mime_type: Option<&str>,
filename: Option<&str>,
data: Option<&[u8]>
)
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. Read more
source§fn add_lyrics(&mut self, lyrics: Lyrics)
fn add_lyrics(&mut self, lyrics: Lyrics)
👎Deprecated: Use add_frame(frame::Lyrics{ .. })
Sets the lyrics (USLT). Read more
source§fn remove_all_lyrics(&mut self)
fn remove_all_lyrics(&mut self)
Removes the lyrics text (USLT) from the tag. Read more
source§fn add_synchronised_lyrics(&mut self, lyrics: SynchronisedLyrics)
fn add_synchronised_lyrics(&mut self, lyrics: SynchronisedLyrics)
👎Deprecated: Use add_frame(frame::SynchronisedLyrics{ .. })
Adds a synchronised lyrics frame (SYLT). Read more
source§fn remove_all_synchronised_lyrics(&mut self)
fn remove_all_synchronised_lyrics(&mut self)
Removes all synchronised lyrics (SYLT) frames from the tag. Read more
source§fn remove_all_chapters(&mut self)
fn remove_all_chapters(&mut self)
/// Removes all chapters (CHAP) frames from the tag. Read more
source§fn remove_all_tables_of_contents(&mut self)
fn remove_all_tables_of_contents(&mut self)
/// Removes all tables of contents (CTOC) frames from the tag. Read more
impl Eq for TableOfContents
impl StructuralPartialEq for TableOfContents
Auto Trait Implementations§
impl RefUnwindSafe for TableOfContents
impl Send for TableOfContents
impl Sync for TableOfContents
impl Unpin for TableOfContents
impl UnwindSafe for TableOfContents
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more