Struct SubtitleMetadata

pub struct SubtitleMetadata {
    pub title: Option<String>,
    pub language: Option<String>,
    pub encoding: String,
    pub frame_rate: Option<f32>,
    pub original_format: SubtitleFormatType,
}

Metadata associated with a subtitle file, containing format and content information.

This structure holds descriptive information about the subtitle file that may be embedded in the file format or derived during processing. It helps maintain context during format conversions and provides useful information for subtitle management.

Fields Description

• title: Optional title of the media or subtitle content
• language: Language code (ISO 639-1/639-3) for the subtitle content
• encoding: Character encoding used in the original file
• frame_rate: Video frame rate for frame-based timing formats
• original_format: The source format before any conversions

Examples

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

let metadata = SubtitleMetadata {
    title: Some("Episode 1".to_string()),
    language: Some("en".to_string()),
    encoding: "UTF-8".to_string(),
    frame_rate: Some(23.976),
    original_format: SubtitleFormatType::Srt,
};

assert!(metadata.is_frame_based());
assert_eq!(metadata.display_name(), "Episode 1 (English)");

Fields

title: Option<String>

Optional title of the subtitle content or associated media.

This may be extracted from the subtitle file header or derived from the filename. Used for display and organization purposes.

language: Option<String>

Language code for the subtitle content.

Uses ISO 639-1 (2-letter) or ISO 639-3 (3-letter) codes. Examples: “en”, “zh”, “ja”, “chi”, “eng”

encoding: String

Character encoding of the original subtitle file.

Common values: “UTF-8”, “UTF-16”, “GB2312”, “BIG5”, “Shift_JIS” This information is crucial for proper text decoding.

frame_rate: Option<f32>

Video frame rate for frame-based timing calculations.

Required for SUB format and useful for timing validation. Common values: 23.976, 24.0, 25.0, 29.97, 30.0

original_format: SubtitleFormatType

Original format type before any conversions.

Tracks the source format to maintain conversion history and format-specific feature compatibility.

Implementations

impl SubtitleMetadata

pub fn new(format: SubtitleFormatType) -> Self

Create new metadata with default values and specified format.

Arguments

• format - The original format type

Examples

let metadata = SubtitleMetadata::new(SubtitleFormatType::Srt);
assert_eq!(metadata.encoding, "UTF-8");

pub fn is_frame_based(&self) -> bool

Check if the subtitle uses frame-based timing.

Returns true if the format requires frame rate information.

pub fn display_name(&self) -> String

Generate a display-friendly name for the subtitle.

Combines title and language information for user presentation.

Returns

A formatted string like “Title (Language)” or just “Language” if no title.

pub fn is_complete(&self) -> bool

Check if the metadata contains complete information.

Returns true if title, language, and frame rate (when needed) are set.

Trait Implementations

impl Clone for SubtitleMetadata

fn clone(&self) -> SubtitleMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubtitleMetadata

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

Formats the value using the given formatter.

impl Default for SubtitleMetadata

fn default() -> Self

Returns the “default value” for a type.