Struct lrc::Lyrics

pub struct Lyrics {
    pub metadata: BTreeSet<IDTag>,
    /* private fields */
}

Fields

metadata: BTreeSet<IDTag>

Metadata about this lyrics.

Implementations

impl Lyrics

pub fn new() -> Self

Returns the “default value” for a type.

impl Lyrics

pub fn from_str<S: AsRef<str>>(s: S) -> Result<Lyrics, LyricsError>

Create a Lyrics instance with a string.

impl Lyrics

pub fn add_line<S: Into<String>>(&mut self, line: S) -> Result<(), LyricsError>

pub fn add_timed_line<S: Into<String>>( &mut self, time_tag: TimeTag, line: S ) -> Result<(), LyricsError>

pub fn add_line_with_multiple_time_tags<S: Into<String>>( &mut self, time_tags: &[TimeTag], line: S ) -> Result<(), LyricsError>

impl Lyrics

pub fn get_lines(&self) -> &[String]

pub fn get_timed_lines(&self) -> &[(TimeTag, Rc<str>)]

pub fn remove_line(&mut self, index: usize) -> String

pub fn remove_timed_line(&mut self, index: usize) -> (TimeTag, Rc<str>)

pub fn find_timed_line_index<N: Into<i64>>(&self, timestamp: N) -> Option<usize>

Trait Implementations

impl Clone for Lyrics

fn clone(&self) -> Lyrics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lyrics

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

Formats the value using the given formatter.

impl Default for Lyrics

fn default() -> Self

Returns the “default value” for a type.

impl Display for Lyrics

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

Formats the value using the given formatter.

impl FromStr for Lyrics

type Err = LyricsError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.