Struct spirit::validation::Result

pub struct Result { /* private fields */ }

A validation result.

The validator (see config_validator) is supposed to return an arbitrary number of these results. Each one can hold a message (with varying severity) and optionally a success and failure actions.

Implementations

impl Result

pub fn new<S: Into<String>>(level: Level, s: S) -> Self

Creates a result with given level and message.

pub fn nothing() -> Self

Creates a result without any message.

pub fn hint<S: Into<String>>(s: S) -> Self

Creates a result with a hint.

pub fn warning<S: Into<String>>(s: S) -> Self

Creates a result with a warning.

pub fn error<S: Into<String>>(s: S) -> Self

Creates an error result.

An error result not only gets to the logs, it also marks the whole config as invalid.

pub fn from_error(e: FError) -> Self

Creates an error result from an actual Error.

The error then is logged with additional information.

pub fn level(&self) -> Level

Returns the result’s level.

pub fn description(&self) -> &str

Returns the message texts.

pub fn detailed_error(&self) -> &Option<FError>

Returns an associated error if there’s one.

Note that the error text is already part of the description.

pub fn on_success<F: FnOnce() + 'static>(self, f: F) -> Self

Attaches (replaces) the success action.

pub fn on_abort<F: FnOnce() + 'static>(self, f: F) -> Self

Attaches (replaces) the failure action.

Trait Implementations

impl Debug for Result

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

Formats the value using the given formatter.

impl Default for Result

fn default() -> Result

Returns the “default value” for a type.

impl From<&'static str> for Result

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<(Level, &'static str)> for Result

fn from((level, s): (Level, &'static str)) -> Self

Converts to this type from the input type.

impl From<(Level, String)> for Result

fn from((level, s): (Level, String)) -> Self

Converts to this type from the input type.

impl From<Error> for Result

fn from(e: FError) -> Self

Converts to this type from the input type.

impl From<Result> for Results

fn from(val: Result) -> Self

Converts to this type from the input type.

impl From<String> for Result

fn from(s: String) -> Self

Converts to this type from the input type.