Skip to main content

Annotated

Struct Annotated 

Source
pub struct Annotated<T, R>
where R: Reducer<T>,
{ pub value: T, /* private fields */ }
Expand description

Newtype that bundles a value T with the reducer R that should merge it. The wrapper is a standalone helper users compose into their state types; it does not hook into StateGraph::add_node directly.

Fields§

§value: T

The current value.

Implementations§

Source§

impl<T, R> Annotated<T, R>
where R: Reducer<T>,

Source

pub const fn new(value: T, reducer: R) -> Self

Wrap value with the supplied reducer.

Source

pub const fn reducer(&self) -> &R

Borrow the inner reducer.

Source

pub fn into_value(self) -> T

Consume the wrapper and return the inner value.

Source

pub fn reduce_in_place(&mut self, update: T)
where T: Default,

Apply the bundled reducer to fold update into self.value.

Source

pub fn reduced(self, update: T) -> Self
where R: Clone,

Consume self, return a new Annotated<T, R> with update folded in.

Source

pub fn merge(self, other: Self) -> Self

Merge two annotated values. Both sides must agree on the reducer type by construction (they share R); the resulting Annotated keeps self’s reducer instance — this matters for stateful reducers, where the current slot’s reducer has the right configuration. Stock reducers (Replace, Append, MergeMap, Max) are unit structs, so the choice is moot for them.

This is the building block the StateMerge derive macro emits per Annotated<T, R> field.

Trait Implementations§

Source§

impl<T: Clone, R> Clone for Annotated<T, R>
where R: Reducer<T> + Clone,

Source§

fn clone(&self) -> Annotated<T, R>

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<T: Debug, R> Debug for Annotated<T, R>
where R: Reducer<T> + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, R> Default for Annotated<T, R>
where T: Default, R: Reducer<T> + Default,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T, R> Freeze for Annotated<T, R>
where T: Freeze, R: Freeze,

§

impl<T, R> RefUnwindSafe for Annotated<T, R>

§

impl<T, R> Send for Annotated<T, R>
where T: Send,

§

impl<T, R> Sync for Annotated<T, R>
where T: Sync,

§

impl<T, R> Unpin for Annotated<T, R>
where T: Unpin, R: Unpin,

§

impl<T, R> UnsafeUnpin for Annotated<T, R>
where T: UnsafeUnpin, R: UnsafeUnpin,

§

impl<T, R> UnwindSafe for Annotated<T, R>
where T: UnwindSafe, R: UnwindSafe,

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<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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