Struct PreprocessResult 

pub struct PreprocessResult {
    pub original: String,
    pub preprocessed: String,
    pub warnings: Vec<CorrectionWarning>,
    pub success: bool,
    pub error: Option<FerroError>,
}

Result of preprocessing an input string.

Fields

original: String

The original input.

preprocessed: String

The preprocessed input (may be same as original if no corrections).

warnings: Vec<CorrectionWarning>

Warnings generated during preprocessing.

success: bool

Whether preprocessing was successful (no rejected errors).

error: Option<FerroError>

Error if preprocessing failed due to a rejected error.

Implementations

impl PreprocessResult

pub fn unchanged(input: String) -> Self

Create a successful result with no changes.

pub fn corrected( original: String, preprocessed: String, warnings: Vec<CorrectionWarning>, ) -> Self

Create a successful result with corrections.

pub fn failed(original: String, error: FerroError) -> Self

Create a failed result.

pub fn has_corrections(&self) -> bool

Returns true if there were any corrections made.

pub fn has_warnings(&self) -> bool

Returns true if there were any warnings.

Trait Implementations

impl Clone for PreprocessResult

fn clone(&self) -> PreprocessResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PreprocessResult

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

Formats the value using the given formatter.