Struct vl53l1::outcome::Outcome

pub struct Outcome<T> {
    pub warning: Option<Warning>,
    /* private fields */
}

An alternative to the Ok variant of Result that allows for handling warnings.

Fields

warning: Option<Warning>

Implementations

impl<T> Outcome<T>

pub fn new(value: T, warning: Option<Warning>) -> Self

Create a new Outcome instance.

pub fn ok(value: T) -> Self

An outcome with no warning.

pub fn warn(value: T, warning: Warning) -> Self

An outcome with a warning.

pub fn map<F, U>(self, f: F) -> Outcome<U>where
    F: FnOnce(T) -> U,

Map the outcome to a new type with the given function.

pub fn ignore_warnings(self, to_ignore: &[Warning]) -> Result<T, Warning>

Returns Ok if the warning was in the set of warnings to be ignored, otherwise returns the Warning as an Err.

pub fn ignore_all_warnings(self) -> T

Ignore warnings if any were emitted and return the value.

pub fn err_on_warning(self) -> Result<T, Warning>

Return an error in the case that a warning was produced.

Trait Implementations

impl<T: Debug> Debug for Outcome<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Outcome<T>

fn default() -> Outcome<T>

Returns the “default value” for a type.

impl<T, E> From<Outcome<T>> for Result<Outcome<T>, E>

fn from(outcome: Outcome<T>) -> Self

Converts to this type from the input type.