Skip to main content

CurrentState

Struct CurrentState 

Source
pub struct CurrentState<T> { /* private fields */ }
Expand description

A retained current-state subscription that returns owned snapshots.

The subscription initially contains the latest state published before it was created. Self::snapshot and Self::changed clone that state while holding the internal Tokio watch borrow only for the duration of the call, so the returned value can safely live across awaits and database writes.

Cloning a subscription creates an independent change cursor over the same retained state.

let mut state = db.self_wot_subscribe();
let snapshot = state.snapshot();

// The snapshot is owned and may remain live across database operations.
let _heads = db.get_heads_self().await;
assert_eq!(
    snapshot.len(),
    snapshot.followees.len() + snapshot.extended.len()
);

let _newer_snapshot = state.changed().await;

The raw Tokio receiver and its borrow guard are intentionally not exposed:

ⓘ
let state = db.self_wot_subscribe();
let _borrow = state.borrow();

Implementations§

Source§

impl<T> CurrentState<T>
where T: Clone,

Source

pub fn snapshot(&self) -> T

Return an owned snapshot of the latest retained state.

This does not advance the subscription’s change cursor. A subsequent Self::changed call immediately returns if it has not yet observed the publication that supplied this snapshot.

Source

pub async fn changed(&mut self) -> Result<T, CurrentStateClosed>

Wait for a publication newer than the cursor and return the latest owned snapshot.

If multiple publications arrive before this call observes them, it coalesces them and returns the latest value. The returned value may equal a previous snapshot because snapshots do not advance the cursor and publishers may publish equal values.

After the publisher closes, this method delivers any last unseen publication before returning CurrentStateClosed. Self::snapshot remains available after closure.

This method is cancellation safe: using it in tokio::select! does not consume an update when another branch wins.

Trait Implementations§

Source§

impl<T: Clone> Clone for CurrentState<T>

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<T: Debug> Debug for CurrentState<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Forget for CurrentState<T>

§

impl<T> Freeze for CurrentState<T>
where Receiver<T>: Freeze,

§

impl<T> Move for CurrentState<T>

§

impl<T> RefUnwindSafe for CurrentState<T>

§

impl<T> Send for CurrentState<T>
where Receiver<T>: Send,

§

impl<T> Sync for CurrentState<T>
where Receiver<T>: Sync,

§

impl<T> Unpin for CurrentState<T>
where Receiver<T>: Unpin,

§

impl<T> UnsafeUnpin for CurrentState<T>

§

impl<T> UnwindSafe for CurrentState<T>
where Receiver<T>: 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<F, I> CastInto<I> for F
where I: CastFrom<F>,

Source§

fn cast_into(self) -> I

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> CompatExt for T

Source§

fn compat(self) -> Compat<T> ⓘ
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T> ⓘ

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T> ⓘ

Applies the Compat adapter by mutable reference. Read more
Source§

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

Source§

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

Source§

impl<F, T> ExpectFrom<F> for T
where T: TryFrom<F>, <T as TryFrom<F>>::Error: Debug,

Source§

fn expect_from(other: F) -> T

Source§

impl<F, I> ExpectInto<I> for F
where I: ExpectFrom<F>,

Source§

fn expect_into(self) -> I

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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 = !

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