Enum StreamItem 

pub enum StreamItem<T> {
    Value(T),
    Error(FluxionError),
}

A stream item that can be either a value or an error.

This enum allows operators to naturally propagate errors through the stream while processing values, following Rx-style error semantics where errors are propagated and do NOT terminate the stream

Variants

Value(T)

A successful value

Error(FluxionError)

An error that does not terminate the stream (it only gets propagated)

Implementations

impl<T> StreamItem<T>

pub const fn is_value(&self) -> bool

Returns true if this is a Value.

pub const fn is_error(&self) -> bool

Returns true if this is an Error.

pub fn ok(self) -> Option<T>

Converts from StreamItem<T> to Option<T>, discarding errors.

pub fn err(self) -> Option<FluxionError>

Converts from StreamItem<T> to Option<FluxionError>, discarding values.

pub fn map<U, F>(self, f: F) -> StreamItem<U>

where F: FnOnce(T) -> U,

Maps a StreamItem<T> to StreamItem<U> by applying a function to the contained value.

Errors are propagated unchanged.

pub fn and_then<U, F>(self, f: F) -> StreamItem<U>

where F: FnOnce(T) -> StreamItem<U>,

Maps a StreamItem<T> to StreamItem<U> by applying a function that can fail.

Errors are propagated unchanged.

pub fn unwrap(self) -> T

where FluxionError: Debug,

Returns the contained value, panicking if it’s an error.

Panics

Panics if the item is an Error.

pub fn expect(self, msg: &str) -> T

where FluxionError: Debug,

Returns the contained value, panicking with a custom message if it’s an error.

Panics

Panics with the provided message if the item is an Error.

Trait Implementations

impl<T: Clone> Clone for StreamItem<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StreamItem<T>

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

Formats the value using the given formatter.

impl<T> From<Result<T, FluxionError>> for StreamItem<T>

fn from(result: Result<T, FluxionError>) -> Self

Converts to this type from the input type.

impl<T> From<StreamItem<T>> for Result<T, FluxionError>

fn from(item: StreamItem<T>) -> Self

Converts to this type from the input type.

impl<T> HasTimestamp for StreamItem<T>

where T: Timestamped,

type Timestamp = <T as HasTimestamp>::Timestamp

The type representing the timestamp

fn timestamp(&self) -> Self::Timestamp

Returns the timestamp value for this item. Stream operators use this to determine the order of items.

impl<T: Ord> Ord for StreamItem<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for StreamItem<T>

fn eq(&self, other: &Self) -> 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<T: PartialOrd> PartialOrd for StreamItem<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Timestamped for StreamItem<T>

where T: Timestamped,

type Inner = <T as Timestamped>::Inner

The type of the inner value wrapped by this timestamped type

fn with_timestamp(value: Self::Inner, timestamp: Self::Timestamp) -> Self

Creates a new instance wrapping the given value with the specified timestamp.

fn into_inner(self) -> Self::Inner

Consumes self and returns the inner value. For wrapper types like Sequenced<T>, this extracts T. For domain types where Inner = Self, this typically returns self.

impl<T: Eq> Eq for StreamItem<T>