Skip to main content

PauseResumeController

Struct PauseResumeController 

Source
pub struct PauseResumeController { /* private fields */ }
Expand description

High-level controller for pausing and resuming workflows by numeric ID.

Internally maps numeric workflow IDs to PauseCheckpoints stored in a PauseCheckpointStore. Numeric IDs are converted to strings for compatibility with the checkpoint store’s string-keyed API.

§Example

use oximedia_workflow::pause_resume::PauseResumeController;

let mut ctrl = PauseResumeController::new();
ctrl.pause(42);
assert!(ctrl.is_paused(42));
ctrl.resume(42);
assert!(!ctrl.is_paused(42));

Implementations§

Source§

impl PauseResumeController

Source

pub fn new() -> Self

Create an empty controller.

Source

pub fn pause(&mut self, workflow_id: u64)

Pause a workflow by its numeric ID.

If the workflow is already paused this is a no-op (the checkpoint is updated with a fresh timestamp by replacing the entry).

Source

pub fn resume(&mut self, workflow_id: u64)

Resume a workflow by removing its pause checkpoint.

If the workflow is not currently paused this is a no-op.

Source

pub fn is_paused(&self, workflow_id: u64) -> bool

Return true if a pause checkpoint exists for the given workflow ID.

Source

pub fn paused_count(&self) -> usize

Return the number of currently paused workflows.

Source

pub fn paused_ids(&self) -> Vec<u64>

List all currently paused workflow IDs.

Trait Implementations§

Source§

impl Debug for PauseResumeController

Source§

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

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

impl Default for PauseResumeController

Source§

fn default() -> PauseResumeController

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

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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