Struct lark_error::WithError

pub struct WithError<T> {
    pub value: T,
    pub errors: Vec<Diagnostic>,
}

Used to indicate an operation that may report an error. Note that there is a subtle -- but important! -- difference between ErrorReported and this type -- returning Err(ErrorReported) indicates that the query invoked some other operation which failed. Returning WithError<X> (where error is Some) indicates that the operation itself is reporting the error. Confusing the two will result in too many or too few error reports being shown to the user.

Fields

value: T

errors: Vec<Diagnostic>

Methods

impl<T> WithError<T>

pub fn ok(value: T) -> WithError<T>

Convenience function: generates a WithError with a result that has no error at all.

pub fn report_error<Cx>(
    cx: Cx,
    label: String,
    span: Span<FileName>
) -> WithError<T> where
    T: ErrorSentinel<Cx>, 

Convenience function: generates a WithError indicating that this query found an error that was not yet reported. The value is the error-sentinel for this type.

pub fn accumulate_errors_into(self, vec: &mut Vec<Diagnostic>) -> T

Append any errors into vec and return our wrapped value.

pub fn assert_no_errors(self) -> T

pub fn into_value(self) -> T

pub fn into_result(self) -> Result<T, ErrorReported>

pub fn map<U>(
    self,
    op: impl FnOnce(T) -> U
) -> WithError<U>

Trait Implementations

impl<T, Cx> ErrorSentinel<Cx> for WithError<T> where
    T: ErrorSentinel<Cx>, 

fn error_sentinel(cx: Cx, report: ErrorReported) -> WithError<T> where
    T: ErrorSentinel<Cx>, 

impl<T: PartialOrd> PartialOrd<WithError<T>> for WithError<T>

fn partial_cmp(&self, other: &WithError<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WithError<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WithError<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WithError<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WithError<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for WithError<T>

impl<T: Ord> Ord for WithError<T>

fn cmp(&self, other: &WithError<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: PartialEq> PartialEq<WithError<T>> for WithError<T>

fn eq(&self, other: &WithError<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WithError<T>) -> bool

This method tests for !=.

impl<T: Clone> Clone for WithError<T>

fn clone(&self) -> WithError<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WithError<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for WithError<T>

fn hash<__HT: Hasher>(&self, state: &mut __HT)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: DebugWith> DebugWith for WithError<T>

fn fmt_with<Cx: ?Sized>(&self, cx: &Cx, fmt: &mut Formatter) -> Result

fn debug_with<Cx>(&'me self, cx: &'me Cx) -> DebugCxPair<'me, &'me Self, Cx> where
    Cx: ?Sized, 

fn into_debug_with<Cx>(self, cx: &'me Cx) -> DebugCxPair<'me, Self, Cx> where
    Cx: ?Sized,