Skip to main content

Lifecycle

Enum Lifecycle 

Source
pub enum Lifecycle<I> {
    Persisted(I),
    Processed(I),
    Skipped(Skip),
    Failed(Failure),
}
Available on crate feature runtime only.
Expand description

Where one item got to, as its consumer states it.

§The stations are CLOSED and the info is OPEN

The four variants are the whole table, because the watermark condition MATCHES on them: a framework that could not enumerate the stations could not decide whether an item is done. The payload is the opposite — I is the consumer’s own detail, and a batch ack is where it earns its keep, since one answer covers many items and per-item detail has nowhere else to go.

§No default parameter

Lifecycle<I> and never Lifecycle<I = ()>. A default would let a consumer write Lifecycle::Processed(()) without noticing it had discarded the one slot the design gave it, and the omission would be invisible at the call site. A consumer with nothing to say writes the unit type on purpose.

§Zero bounds

I is bounded nowhere in this type, nowhere in Ack, and nowhere in the transport. The single bound is at AckSender::send, the erased boundary, and it is Any + Send + Sync — what crossing an object-safe tap costs and nothing more. A bound written here would be paid by every consumer whether or not its info ever reached a tap.

§Why it CLONES

One outcome can be owed to SEVERAL senders. A keyed group’s delivery answers the token of every member that joined it — see Custody — and those answers state the same station and the same detail, differing only in which keys each releases. So the station travels by value to each of them, which is what Clone is here for. I: Clone is the caller’s to satisfy and the driver’s own info type (Tally) is Copy; a one-token delivery clones nothing.

Variants§

§

Persisted(I)

The item’s effect is durable in this consumer’s own store. The station a landing consumer reaches, and the one that makes a channel ack safe to release: the oneshot fires AFTER the write, never before it.

§

Processed(I)

The item was processed and this consumer lands nothing — a pure operator’s station.

§

Skipped(Skip)

The item was intentionally refused, as the operator states it. The refusal travels whole, because Skip already carries both halves an app needs: WHY, and — where the operator could say so — WHICH content.

§

Failed(Failure)

The item could not be processed. It holds the window: a failed item is named in no Ack::released set, so the sender re-delivers it.

The failure crosses ERASED for the reason I does — one tap observes every node in the arrangement and each carries its own Operator::Error.

Implementations§

Source§

impl<I> Lifecycle<I>

Source

pub const fn is_persisted(&self) -> bool

Returns true if this value is of type Persisted. Returns false otherwise

Source

pub const fn is_processed(&self) -> bool

Returns true if this value is of type Processed. Returns false otherwise

Source

pub const fn is_skipped(&self) -> bool

Returns true if this value is of type Skipped. Returns false otherwise

Source

pub const fn is_failed(&self) -> bool

Returns true if this value is of type Failed. Returns false otherwise

Source§

impl<I> Lifecycle<I>

Source

pub fn unwrap_persisted(self) -> I

Unwraps this value to the Lifecycle::Persisted variant. Panics if this value is of any other type.

Source

pub fn unwrap_persisted_ref(&self) -> &I

Unwraps this reference to the Lifecycle::Persisted variant. Panics if this value is of any other type.

Source

pub fn unwrap_persisted_mut(&mut self) -> &mut I

Unwraps this mutable reference to the Lifecycle::Persisted variant. Panics if this value is of any other type.

Source

pub fn unwrap_processed(self) -> I

Unwraps this value to the Lifecycle::Processed variant. Panics if this value is of any other type.

Source

pub fn unwrap_processed_ref(&self) -> &I

Unwraps this reference to the Lifecycle::Processed variant. Panics if this value is of any other type.

Source

pub fn unwrap_processed_mut(&mut self) -> &mut I

Unwraps this mutable reference to the Lifecycle::Processed variant. Panics if this value is of any other type.

Source

pub fn unwrap_skipped(self) -> Skip

Unwraps this value to the Lifecycle::Skipped variant. Panics if this value is of any other type.

Source

pub fn unwrap_skipped_ref(&self) -> &Skip

Unwraps this reference to the Lifecycle::Skipped variant. Panics if this value is of any other type.

Source

pub fn unwrap_skipped_mut(&mut self) -> &mut Skip

Unwraps this mutable reference to the Lifecycle::Skipped variant. Panics if this value is of any other type.

Source

pub fn unwrap_failed(self) -> Failure

Unwraps this value to the Lifecycle::Failed variant. Panics if this value is of any other type.

Source

pub fn unwrap_failed_ref(&self) -> &Failure

Unwraps this reference to the Lifecycle::Failed variant. Panics if this value is of any other type.

Source

pub fn unwrap_failed_mut(&mut self) -> &mut Failure

Unwraps this mutable reference to the Lifecycle::Failed variant. Panics if this value is of any other type.

Source§

impl<I> Lifecycle<I>

Source

pub fn try_unwrap_persisted(self) -> Result<I, TryUnwrapError<Self>>

Attempts to unwrap this value to the Lifecycle::Persisted variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_persisted_ref(&self) -> Result<&I, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Lifecycle::Persisted variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_persisted_mut( &mut self, ) -> Result<&mut I, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the Lifecycle::Persisted variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_processed(self) -> Result<I, TryUnwrapError<Self>>

Attempts to unwrap this value to the Lifecycle::Processed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_processed_ref(&self) -> Result<&I, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Lifecycle::Processed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_processed_mut( &mut self, ) -> Result<&mut I, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the Lifecycle::Processed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_skipped(self) -> Result<Skip, TryUnwrapError<Self>>

Attempts to unwrap this value to the Lifecycle::Skipped variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_skipped_ref(&self) -> Result<&Skip, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Lifecycle::Skipped variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_skipped_mut( &mut self, ) -> Result<&mut Skip, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the Lifecycle::Skipped variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_failed(self) -> Result<Failure, TryUnwrapError<Self>>

Attempts to unwrap this value to the Lifecycle::Failed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_failed_ref(&self) -> Result<&Failure, TryUnwrapError<&Self>>

Attempts to unwrap this reference to the Lifecycle::Failed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source

pub fn try_unwrap_failed_mut( &mut self, ) -> Result<&mut Failure, TryUnwrapError<&mut Self>>

Attempts to unwrap this mutable reference to the Lifecycle::Failed variant. Returns a [TryUnwrapError] with the original value if this value is of any other type.

Source§

impl<I> Lifecycle<I>

Source

pub const fn station(&self) -> Station

Which station this is, without the payload.

Source

pub fn erase(self) -> Observation
where I: Any + Send + Sync,

Cross the tap boundary: keep the station and the framework’s own payloads, and hold the consumer’s info as Any for a tap that knows what to ask for.

This is where I acquires its only bound — see the type note.

Source

pub fn arrive(self) -> Arrival
where I: Any + Send + Sync,

The Arrival alone, without the observation wrapper — what the ack path carries and what a journal row is written from.

Trait Implementations§

Source§

impl<I: Clone> Clone for Lifecycle<I>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Debug> Debug for Lifecycle<I>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<I> !Freeze for Lifecycle<I>

§

impl<I> !RefUnwindSafe for Lifecycle<I>

§

impl<I> !UnwindSafe for Lifecycle<I>

§

impl<I> Send for Lifecycle<I>
where I: Send,

§

impl<I> Sync for Lifecycle<I>
where I: Sync,

§

impl<I> Unpin for Lifecycle<I>
where I: Unpin,

§

impl<I> UnsafeUnpin for Lifecycle<I>
where I: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Fruit for T
where T: Send + Downcast,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> State<Identity> for T

Source§

type Output = T

The type Self projects to.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more