Struct LineTag 

pub struct LineTag {
    pub timestamp: Duration,
    pub segments: Vec<SegmentTag>,
}

A single line in the synced lyrics.

Fields

timestamp: Duration

The timestamp at which the line starts.

Can be the same as or earlier than the timestamp of first segment (if the A2 extension is used).

segments: Vec<SegmentTag>

Timestamped segments of the line.

With regular LRC files, this will contain at most one element. If the enhanced LRC format is used, it may contain more elements.

Implementations

impl LineTag

pub fn new(timestamp: Duration, content: String) -> LineTag

Create a new line tag with a single segment with the same timestamp.

Examples

assert_eq!(
    LineTag::new(Duration::from_secs(1), "La la la".to_string()),
    // You can save a lot of boilerplate code
    LineTag {
        timestamp: Duration::from_secs(1),
        segments: vec![SegmentTag {
            timestamp: Duration::from_secs(1),
            content: "La la la".to_string()
        }]
    }
);

pub fn timestamp(&mut self, timestamp: Duration) -> Option<&mut LineTag>

Sets the timestamp of the line.

Returns None if the timestamp is later than the first segment of the line.

pub fn segment( &mut self, segment: SegmentTag, ) -> Result<&mut LineTag, TimestampError>

Adds a segment to the line.

Prefer using this method over manually adding segments to lines as it ensures that the timestamp order stays correct. If you need to add segments manually, use the check_timestamp_order method to verify the timestamp order.

pub fn segments( &mut self, segments: &[SegmentTag], ) -> Result<&mut LineTag, TimestampError>

Adds multiple segments to the line.

Prefer using this method over manually adding segments to lines as it ensures that the timestamp order stays correct. If you need to add segments manually, use the check_timestamp_order method to verify the timestamp order.

Trait Implementations

impl Clone for LineTag

fn clone(&self) -> LineTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineTag

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

Formats the value using the given formatter.

impl Default for LineTag

fn default() -> LineTag

Returns the “default value” for a type.

impl Eq for LineTag

impl<'a> From<TimestampedTag<'a>> for LineTag

Available on crate feature parser only.

fn from(value: TimestampedTag<'_>) -> LineTag

Converts to this type from the input type.

impl Hash for LineTag

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

where __H: Hasher,

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 LyricsAccess<LineTag> for SyncedLyrics

fn is_active(&self, timestamp: Duration) -> bool

Returns whether the lyrics are active for the given timestamp.

Lyrics are considered active if timestamp is greater than or equal to the timestamp of the first line of the lyrics. The first line is assumed to have the earliest timestamp, so if the line order is not correct this method may return wrong results.

Examples

let lyrics = SyncedLyrics::try_new(vec![
    LineTag {
        // Checking whether lyrics are active is delegated to the first line
        timestamp: Duration::from_secs(11),
        segments: vec![
            SegmentTag::new(Duration::from_secs(12), String::new()),
            SegmentTag::new(Duration::from_secs(15), String::new())
        ]
    },
    // All other stuff doesn't matter
    LineTag {
        timestamp: Duration::from_secs(17),
        segments: vec![SegmentTag::new(Duration::from_secs(17), String::new())]
    }
])
.unwrap();

assert!(!lyrics.is_active(Duration::default()));
assert!(!lyrics.is_active(Duration::from_secs(3)));
assert!(lyrics.is_active(Duration::from_secs(11)));
assert!(lyrics.is_active(Duration::from_secs(67)));
assert!(lyrics.is_active(Duration::from_secs(u64::MAX)));

fn to_unsynced(self) -> String

Returns unsynced lyrics without timestamps or additional metadata.

fn active_tag_index(&self, timestamp: Duration) -> Option<usize>

Returns the index of the active tag or None if no tag is active for the given timestamp.

fn active_tag(&self, timestamp: Duration) -> Option<&LineTag>

Returns the active tag or None if no tag is active for the given timestamp.

fn check_timestamp_order(&self) -> Result<(), TimestampError>

Checks if timed tag timestamps are ordered correctly.

fn is_enhanced_lrc(&self) -> bool

Returns whether the element contains tags indicating that it uses the enhanced LRC format.

impl LyricsAccess<SegmentTag> for LineTag

fn is_active(&self, timestamp: Duration) -> bool

Returns whether the line is active for the given timestamp.

A line is considered active if timestamp is greater than or equal to the line timestamp. The line timestamp is considered to be the earliest, so if any of the segments have a timestamp that is earlier than the line timestamp, this method will return wrong results.

Examples

let line = LineTag {
    // Only this timestamp is considered when evaluating whether the line is active or not
    timestamp: Duration::from_secs(5),
    // Those segments don't actually matter here
    segments: vec![
        SegmentTag::new(Duration::from_secs(5), String::new()),
        SegmentTag::new(Duration::from_secs(7), String::new()),
    ],
};

assert!(!line.is_active(Duration::default()));
assert!(!line.is_active(Duration::from_secs(3)));
assert!(line.is_active(Duration::from_secs(5)));
assert!(line.is_active(Duration::from_secs(23)));
assert!(line.is_active(Duration::from_secs(u64::MAX)));

fn to_unsynced(self) -> String

Returns unsynced lyrics without timestamps or additional metadata.

fn active_tag_index(&self, timestamp: Duration) -> Option<usize>

Returns the index of the active tag or None if no tag is active for the given timestamp.

fn active_tag(&self, timestamp: Duration) -> Option<&SegmentTag>

Returns the active tag or None if no tag is active for the given timestamp.

fn check_timestamp_order(&self) -> Result<(), TimestampError>

Checks if timed tag timestamps are ordered correctly.

fn is_enhanced_lrc(&self) -> bool

Returns whether the element contains tags indicating that it uses the enhanced LRC format.

impl Ord for LineTag

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for LineTag

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LineTag

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for LineTag