Struct ConvertArgs

pub struct ConvertArgs {
    pub input: PathBuf,
    pub format: Option<OutputSubtitleFormat>,
    pub output: Option<PathBuf>,
    pub keep_original: bool,
    pub encoding: String,
}

Command-line arguments for subtitle format conversion.

The convert command transforms subtitle files between different formats while preserving timing information and content structure. It supports both single file and batch directory processing.

Examples

use subx_cli::cli::ConvertArgs;
use subx_cli::cli::OutputSubtitleFormat;
use std::path::PathBuf;

let args = ConvertArgs {
    input: PathBuf::from("input.srt"),
    format: Some(OutputSubtitleFormat::Ass),
    output: Some(PathBuf::from("output.ass")),
    keep_original: true,
    encoding: "utf-8".to_string(),
};

Fields

input: PathBuf

Input file or directory path containing subtitle files.

For single file conversion, specify the exact file path. For batch processing, specify a directory path and all supported subtitle files will be processed.

format: Option<OutputSubtitleFormat>

Target output format for converted subtitles.

If not specified, the default format from configuration will be used. Supported formats include SRT, ASS, VTT, and SUB.

Examples

--format srt    # Convert to SubRip format
--format ass    # Convert to Advanced SubStation Alpha
--format vtt    # Convert to WebVTT format
--format sub    # Convert to MicroDVD/SubViewer format

output: Option<PathBuf>

Output file path for the converted subtitle.

If not specified for single file conversion, the output will use the same name as input with the appropriate extension. For batch processing, files are saved with new extensions in the same directory or a format-specific subdirectory.

keep_original: bool

Preserve the original files after conversion.

By default, original files are preserved. Use this flag to explicitly keep originals during batch processing operations.

encoding: String

Character encoding for input and output files.

Specifies the character encoding to use when reading input files and writing output files. UTF-8 is the default and recommended encoding for maximum compatibility.

Supported Encodings

• UTF-8 (default, recommended)
• UTF-16LE, UTF-16BE
• Windows-1252 (Western European)
• ISO-8859-1 (Latin-1)
• GBK, GB2312 (Chinese)
• Shift_JIS (Japanese)

Examples

--encoding utf-8        # UTF-8 encoding (default)
--encoding windows-1252 # Windows Western European
--encoding gbk          # Chinese GBK encoding

Trait Implementations

impl Args for ConvertArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for ConvertArgs

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

Formats the value using the given formatter.

impl FromArgMatches for ConvertArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.