Struct ErrorStream 

pub struct ErrorStream<E>(/* private fields */);

A non-empty stream of errors.

Logically, this type is unordered, and it is not guaranteed that the errors will be returned in the order they were added. Attach identifying information to your errors if you want to sort them.

This struct is intended to be used with:

• The CombineErrors trait, which allows you to combine a tuples of results.
• The CollectAllErrors trait, which allows you to collect errors from an iterator of results.

To create an ErrorStream from a single error, you can use from or into:

use spacetimedb_data_structures::error_stream::ErrorStream;

enum MyError {
    A(u32),
    B
}

let error: ErrorStream<MyError> = MyError::A(1).into();
// or
let error = ErrorStream::from(MyError::A(1));

This does not allocate (unless your error allocates, of course).

Implementations

impl<E> ErrorStream<E>

pub fn expect_nonempty<I: IntoIterator<Item = E>>(errors: I) -> Self

Build an error stream from a non-empty collection. If the collection is empty, panic.

pub fn add_extra_errors<T>( result: Result<T, ErrorStream<E>>, extra_errors: impl IntoIterator<Item = E>, ) -> Result<T, ErrorStream<E>>

Add some extra errors to a result.

If there are no errors, the result is not modified. If there are errors, and the result is Err, the errors are added to the stream. If there are errors, and the result is Ok, the Ok value is discarded, and the errors are returned in a stream.

pub fn iter(&self) -> impl Iterator<Item = &E>

Returns an iterator over the errors in the stream.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut E>

Returns a mutable iterator over the errors in the stream.

pub fn drain(&mut self) -> impl Iterator<Item = E> + '_

Returns an iterator over the errors in the stream, consuming the stream.

pub fn push(&mut self, error: E)

Push an error onto the stream.

pub fn extend(&mut self, other: impl IntoIterator<Item = E>)

Extend the stream with another stream.

impl<E: Ord + Eq> ErrorStream<E>

pub fn sort_deduplicate(self) -> Self

Sort and deduplicate the errors in the error stream.

impl<E: Eq + Hash> ErrorStream<E>

pub fn hash_deduplicate(self) -> Self

Hash and deduplicate the errors in the error stream. The resulting error stream has an arbitrary order.

Trait Implementations

impl<E: Clone> Clone for ErrorStream<E>

fn clone(&self) -> ErrorStream<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for ErrorStream<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for ErrorStream<E>

fn default() -> ErrorStream<E>

Returns the “default value” for a type.

impl<E: Display> Display for ErrorStream<E>

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

Formats the value using the given formatter.

impl<E> Error for ErrorStream<E>

where Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<E> From<E> for ErrorStream<E>

fn from(error: E) -> Self

Converts to this type from the input type.

impl<E> IntoIterator for ErrorStream<E>

type Item = <SmallVec<[E; 1]> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <SmallVec<[E; 1]> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<E: PartialEq> PartialEq for ErrorStream<E>

fn eq(&self, other: &ErrorStream<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E: Eq> Eq for ErrorStream<E>

impl<E> StructuralPartialEq for ErrorStream<E>