Struct DetectEncodingArgs

pub struct DetectEncodingArgs {
    pub verbose: bool,
    pub file_paths: Vec<String>,
}

Command-line arguments for file encoding detection.

The detect-encoding command analyzes the byte patterns and character distributions in text files to determine their most likely character encoding. This is essential for processing subtitle files that may have been created with different encodings.

Detection Algorithm

The detection process uses multiple approaches:

1. BOM (Byte Order Mark) detection for Unicode files
2. Statistical analysis of byte patterns
3. Character frequency analysis for specific languages
4. Heuristic rules based on encoding characteristics

Examples

use subx_cli::cli::DetectEncodingArgs;

let args = DetectEncodingArgs {
    verbose: true,
    file_paths: vec![
        "subtitle1.srt".to_string(),
        "subtitle2.ass".to_string(),
    ],
};

Fields

verbose: bool

Display detailed sample text and confidence information.

When enabled, shows additional information about the detection process:

• Confidence percentage for the detected encoding
• Sample text decoded with the detected encoding
• Alternative encoding candidates with their confidence scores
• Detected language hints (if available)

This is useful for verifying detection accuracy and troubleshooting encoding issues with problematic files.

Examples

# Basic detection
subx detect-encoding file.srt
# Output: file.srt: UTF-8

# Verbose detection with details
subx detect-encoding --verbose file.srt
# Output:
# file.srt: UTF-8 (99.5% confidence)
# Sample: "1\n00:00:01,000 --> 00:00:03,000\nHello World"
# Alternatives: ISO-8859-1 (15.2%), Windows-1252 (12.8%)

file_paths: Vec<String>

File paths to analyze for encoding detection.

Accepts multiple file paths or glob patterns. All specified files will be analyzed and their detected encodings reported. The command supports both absolute and relative paths.

Supported File Types

While primarily designed for subtitle files, the detection works with any text-based file:

• Subtitle files: .srt, .ass, .vtt, .sub, .ssa, .smi
• Text files: .txt, .md, .csv, .json, .xml
• Script files: .py, .js, .html, .css

Examples

# Single file
subx detect-encoding subtitle.srt

# Multiple specific files
subx detect-encoding file1.srt file2.ass file3.vtt

# Glob patterns (shell expansion)
subx detect-encoding *.srt
subx detect-encoding subtitles/*.{srt,ass}

# Mixed paths
subx detect-encoding /absolute/path/file.srt ./relative/file.ass

Error Handling

If a file cannot be read or analyzed:

• The error is reported for that specific file
• Processing continues with remaining files
• Non-text files are skipped with a warning
• Permission errors are clearly indicated

Trait Implementations

impl Args for DetectEncodingArgs

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 DetectEncodingArgs

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

Formats the value using the given formatter.

impl FromArgMatches for DetectEncodingArgs

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.