Struct Subtitle

pub struct Subtitle {
    pub entries: Vec<SubtitleEntry>,
    pub metadata: SubtitleMetadata,
    pub format: SubtitleFormatType,
}

Unified subtitle data structure containing entries, metadata, and format information.

This structure represents a complete subtitle file in memory, providing a format-agnostic representation that can be converted between different subtitle formats while preserving as much information as possible.

Examples

use subx_cli::core::formats::{Subtitle, SubtitleEntry, SubtitleMetadata, SubtitleFormatType};
use std::time::Duration;

let subtitle = Subtitle {
    entries: vec![
        SubtitleEntry {
            index: 1,
            start_time: Duration::from_secs(10),
            end_time: Duration::from_secs(13),
            text: "Hello, world!".to_string(),
            styling: None,
        }
    ],
    metadata: SubtitleMetadata {
        title: Some("Movie Title".to_string()),
        language: Some("en".to_string()),
        encoding: "UTF-8".to_string(),
        frame_rate: Some(23.976),
        original_format: SubtitleFormatType::Srt,
    },
    format: SubtitleFormatType::Srt,
};

println!("Subtitle has {} entries", subtitle.entries.len());

Fields

entries: Vec<SubtitleEntry>

Collection of subtitle entries with timing and text content.

metadata: SubtitleMetadata

Metadata information about the subtitle file.

format: SubtitleFormatType

Current format type of the subtitle data.

Implementations

impl Subtitle

pub fn new(format: SubtitleFormatType, metadata: SubtitleMetadata) -> Self

Create a new subtitle with the given format and metadata.

Arguments

• format - The subtitle format type
• metadata - Metadata associated with the subtitle

Examples

use subx_cli::core::formats::{Subtitle, SubtitleMetadata, SubtitleFormatType};

let metadata = SubtitleMetadata::default();
let subtitle = Subtitle::new(SubtitleFormatType::Srt, metadata);
assert_eq!(subtitle.entries.len(), 0);

pub fn total_duration(&self) -> Duration

Get the total duration of the subtitle file.

Returns the time span from the first entry’s start time to the last entry’s end time, or zero if there are no entries.

Examples

let duration = subtitle.total_duration();
println!("Subtitle duration: {:.2} seconds", duration.as_secs_f32());

pub fn has_overlaps(&self) -> bool

Check if subtitle entries have any timing overlaps.

Returns true if any entry’s start time is before the previous entry’s end time, indicating overlapping subtitles.

pub fn sort_entries(&mut self)

Sort entries by start time to ensure chronological order.

This method is useful after manual manipulation of entries or when merging subtitles from multiple sources.

Trait Implementations

impl Clone for Subtitle

fn clone(&self) -> Subtitle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subtitle

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

Formats the value using the given formatter.