Struct SourceInfoResult

pub struct SourceInfoResult {
    source_info: SourceInfoV1,
    errors: Option<SourceInfoErrors>,
}

Wraps the outcome of SourceInfoV1::from_string.

While building a SourceInfoV1 from raw SourceInfoContent, errors as well as deprecation and linter warnings may be encountered.

In case no errors are encountered, the resulting SourceInfoV1 may be accessed via SourceInfoResult::source_info.

Fields

source_info: SourceInfoV1

errors: Option<SourceInfoErrors>

Implementations

impl SourceInfoResult

pub fn source_info(self) -> Result<SourceInfoV1, Error>

Returns the SourceInfoV1 as long as no critical errors have been encountered.

Errors

Returns an error if any kind of unrecoverable logic error is encountered, such as missing properties

pub fn incomplete_source_info(&self) -> &SourceInfoV1

Returns the generated SourceInfoV1 regardless of whether there’re any errors or not.

Warning

This SourceInfoV1 struct may be incomplete, could contain invalid information and/or invalid default values!

Only use this if you know what you’re doing and if you want to do stuff like manual auto-correction.

pub fn lint(self) -> Result<SourceInfoV1, Error>

Returns a the SourceInfoV1 as long as there’re no errors, lints or warnings of any kind.

Errors

Any kind of error, warning or lint is encountered.

pub fn errors(&self) -> Option<&SourceInfoErrors>

Gets a reference to the errors of this result.

Trait Implementations

impl Clone for SourceInfoResult

fn clone(&self) -> SourceInfoResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceInfoResult

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

Formats the value using the given formatter.