OpQueue

Struct OpQueue 

Source
pub(crate) struct OpQueue<Args = (), Output = ()> {
    op_requested: Option<(String, Args)>,
    op_in_progress: bool,
    last_op_result: Option<Output>,
}
Expand description

A single-item queue that allows callers to request an operation to be performed later.

let queue = OpQueue::default();

// Request work to be done.
queue.request_op("user pushed a button", ());

// In a later iteration of the server loop, we start the work.
if let Some((_cause, ())) = queue.should_start_op() {
    dbg!("Some slow operation here");
}

// In an even later iteration of the server loop, we can see that the work
// was completed.
if !queue.op_in_progress() {
    dbg!("Work has been done!");
}

Fields§

§op_requested: Option<(String, Args)>§op_in_progress: bool§last_op_result: Option<Output>

Implementations§

Source§

impl<Args: Debug, Output> OpQueue<Args, Output>

Source

pub(crate) fn request_op(&mut self, reason: String, args: Args)

Request an operation to start.

Source

pub(crate) fn should_start_op(&mut self) -> Option<(String, Args)>

If there was an operation requested, mark this queue as started and return the request arguments.

Source

pub(crate) fn op_completed(&mut self, result: Output)

Mark an operation as completed.

Source

pub(crate) fn last_op_result(&self) -> Option<&Output>

Get the result of the last operation.

Source

pub(crate) fn op_in_progress(&self) -> bool

Source

pub(crate) fn op_requested(&self) -> bool

Trait Implementations§

Source§

impl<Args: Debug, Output: Debug> Debug for OpQueue<Args, Output>

Source§

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

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

impl<Args, Output> Default for OpQueue<Args, Output>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<Args, Output> Freeze for OpQueue<Args, Output>
where Output: Freeze, Args: Freeze,

§

impl<Args, Output> RefUnwindSafe for OpQueue<Args, Output>
where Output: RefUnwindSafe, Args: RefUnwindSafe,

§

impl<Args, Output> Send for OpQueue<Args, Output>
where Output: Send, Args: Send,

§

impl<Args, Output> Sync for OpQueue<Args, Output>
where Output: Sync, Args: Sync,

§

impl<Args, Output> Unpin for OpQueue<Args, Output>
where Output: Unpin, Args: Unpin,

§

impl<Args, Output> UnwindSafe for OpQueue<Args, Output>
where Output: UnwindSafe, Args: 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
§

impl<T, R> CollectAndApply<T, R> for T

§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

§

type Output = R

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> IntoBox<dyn Any> for T
where T: Any,

§

fn into_box(self) -> Box<dyn Any>

Convert self into the appropriate boxed form.
§

impl<T> IntoBox<dyn Any + Send> for T
where T: Any + Send,

§

fn into_box(self) -> Box<dyn Any + Send>

Convert self into the appropriate boxed form.
§

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

§

fn into_box(self) -> Box<dyn Any + Send + Sync>

Convert self into the appropriate boxed form.
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
§

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

§

fn upcast(self, interner: I) -> U

§

impl<I, T> UpcastFrom<I, T> for T

§

fn upcast_from(from: T, _tcx: I) -> T

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<'a, T> Captures<'a> for T
where T: ?Sized,

§

impl<T> ErasedDestructor for T
where T: 'static,