Struct AlignmentConfig 

pub struct AlignmentConfig {
    pub case_sensitive: bool,
    pub algorithm: AlignmentAlgorithm,
    pub annotation_id_prefix: Option<String>,
    pub trim: bool,
    pub simple_only: bool,
    pub minimal_align_length: usize,
    pub max_errors: Option<AbsoluteOrRelative>,
    pub grow: bool,
    pub verbose: bool,
    pub quiet: bool,
}

Fields

case_sensitive: bool

Case-insensitive matching has more performance overhead

algorithm: AlignmentAlgorithm

annotation_id_prefix: Option<String>

Prefix to use when assigning annotation IDs. The actual ID will have a random component

trim: bool

Strip leading and trailing whitespace/newlines from aligned text selections, keeping them as minimal as possible (default is to be as greedy as possible in selecting) Setting this may lead to certain whitespaces not being covered even though they may align.

simple_only: bool

Only allow for alignments that consist of one contiguous text selection on either side. This is a so-called simple transposition.

minimal_align_length: usize

The minimal number of characters that must be aligned (absolute number) for a transposition/translation to be valid

max_errors: Option<AbsoluteOrRelative>

The maximum number of errors (max edit distance) that may occur for a transposition to be valid. This is either an absolute integer or a relative ratio between 0.0 and 1.0, interpreted in relation to the length of the first text in the alignment. In other words; this represents the number of characters in the search string that may be missed when matching in the larger text. The transposition itself will only consist of fully matching parts, use grow if you want to include non-matching parts.

grow: bool

Grow aligned parts into larger alignments by incorporating non-matching parts. This will return translations rather than transpositions. You’ll want to set max_errors in combination with this one to prevent very low-quality alignments.

verbose: bool

Output alignments to standard output in a TSV format

quiet: bool

Limit output

Trait Implementations

impl Clone for AlignmentConfig

fn clone(&self) -> AlignmentConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlignmentConfig

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

Formats the value using the given formatter.

impl Default for AlignmentConfig

fn default() -> Self

Returns the “default value” for a type.