Skip to main content

RunControl

Struct RunControl 

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

Graceful shutdown control for Pregel execution

Allows external callers to request drain (finish current tasks but don’t start new ones). Checked in PregelLoop::tick() before computing next tasks.

§Examples

use juncture_core::pregel::loop_::RunControl;

let run_control = RunControl::new();

// Request drain from another thread
let rc_clone = run_control.clone();
std::thread::spawn(move || {
    // After some condition, request drain
    rc_clone.request_drain();
});

// In the main loop
if run_control.is_drain_requested() {
    // Finish current tasks but don't start new ones
}

Implementations§

Source§

impl RunControl

Source

pub fn new() -> Self

Create a new run control instance

§Examples
use juncture_core::pregel::loop_::RunControl;

let run_control = RunControl::new();
assert!(!run_control.is_drain_requested());
Source

pub fn request_drain(&self)

Request drain (finish current tasks but don’t start new ones)

This is thread-safe and can be called from any thread.

§Examples
use juncture_core::pregel::loop_::RunControl;

let run_control = RunControl::new();
run_control.request_drain();
assert!(run_control.is_drain_requested());
Source

pub fn is_drain_requested(&self) -> bool

Check if drain has been requested

§Examples
use juncture_core::pregel::loop_::RunControl;

let run_control = RunControl::new();
assert!(!run_control.is_drain_requested());

Trait Implementations§

Source§

impl Clone for RunControl

Source§

fn clone(&self) -> RunControl

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 Debug for RunControl

Source§

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

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

impl Default for RunControl

Source§

fn default() -> Self

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