Enum OutputSubtitleFormat 

pub enum OutputSubtitleFormat {
    Srt,
    Ass,
    Vtt,
    Sub,
}

Supported output subtitle formats for conversion operations.

This enum defines all subtitle formats that SubX can generate as output. Each format has specific characteristics and use cases:

• SRT: Simple, widely supported, good for basic subtitles
• ASS: Advanced formatting, styling, and positioning capabilities
• VTT: Web-optimized, supports HTML5 video elements
• SUB: Frame-based timing, used in some legacy systems

Format Characteristics

Format	Timing	Styling	Web Support	Compatibility
SRT	Time	Basic	Good	Excellent
ASS	Time	Rich	Limited	Good
VTT	Time	Medium	Excellent	Good
SUB	Frame	Basic	Poor	Limited

Examples

use subx_cli::cli::OutputSubtitleFormat;

let srt_format = OutputSubtitleFormat::Srt;
assert_eq!(srt_format.as_str(), "srt");
assert_eq!(srt_format.file_extension(), ".srt");

Variants

Srt

SubRip (.srt) format - most widely supported subtitle format.

Features:

• Simple time-based format
• Basic text formatting (bold, italic, underline)
• Excellent player compatibility
• Small file size

Ass

Advanced SubStation Alpha (.ass) format - professional subtitle format.

Features:

• Rich styling and formatting options
• Precise positioning and animation
• Multiple font and color support
• Advanced timing controls

Vtt

WebVTT (.vtt) format - web-optimized subtitle format.

Features:

• HTML5 video element support
• CSS-like styling capabilities
• Cue positioning and alignment
• Web accessibility features

Sub

MicroDVD/SubViewer (.sub) format - frame-based subtitle format.

Features:

• Frame-based timing (not time-based)
• Basic text formatting
• Legacy format support
• Compact file structure

Implementations

impl OutputSubtitleFormat

pub fn as_str(&self) -> &'static str

Returns the format identifier as a string.

This method provides the lowercase string representation of the format, which is used for command-line arguments and configuration files.

Examples

use subx_cli::cli::OutputSubtitleFormat;

assert_eq!(OutputSubtitleFormat::Srt.as_str(), "srt");
assert_eq!(OutputSubtitleFormat::Ass.as_str(), "ass");
assert_eq!(OutputSubtitleFormat::Vtt.as_str(), "vtt");
assert_eq!(OutputSubtitleFormat::Sub.as_str(), "sub");

pub fn file_extension(&self) -> &'static str

Returns the file extension for this format including the dot prefix.

This method provides the standard file extension used for each subtitle format, which is useful for generating output filenames.

Examples

use subx_cli::cli::OutputSubtitleFormat;

assert_eq!(OutputSubtitleFormat::Srt.file_extension(), ".srt");
assert_eq!(OutputSubtitleFormat::Ass.file_extension(), ".ass");
assert_eq!(OutputSubtitleFormat::Vtt.file_extension(), ".vtt");
assert_eq!(OutputSubtitleFormat::Sub.file_extension(), ".sub");

Trait Implementations

impl Clone for OutputSubtitleFormat

fn clone(&self) -> OutputSubtitleFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputSubtitleFormat

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

Formats the value using the given formatter.

impl Display for OutputSubtitleFormat

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

Formats the value using the given formatter.

impl PartialEq for OutputSubtitleFormat

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ValueEnum for OutputSubtitleFormat

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Eq for OutputSubtitleFormat

impl StructuralPartialEq for OutputSubtitleFormat