Skip to main content

RunControl

Struct RunControl 

Source
pub struct RunControl {
    pub cancel: Arc<AtomicBool>,
    pub progress: Arc<Progress>,
    pub threads: Option<NonZeroUsize>,
    pub batch_limits: BatchLimits,
    pub expected_probe: Option<ProbeFacts>,
    pub thread_start: Option<Hook>,
    pub threads_ready: Option<Hook>,
}
Expand description

Cancellation, progress and threading for one analysis.

Fields§

§cancel: Arc<AtomicBool>

Set to request cancellation; the analysis returns DimaError::Cancelled promptly.

§progress: Arc<Progress>

Progress counters.

§threads: Option<NonZeroUsize>

Worker threads; None uses the available parallelism.

§batch_limits: BatchLimits

Batch limits of the reader (defaults per D40; smaller values only change memory use and are used by tests to exercise batch boundaries — results never depend on them).

§expected_probe: Option<ProbeFacts>

What a pre-check saw in the input’s first batch (D108). When set, the run stops with DimaError::InputChanged before counting if its own first batch differs, so a file replaced after it was checked is never analysed with settings chosen for another one. It never changes results.

§thread_start: Option<Hook>

Runs first in every thread the analysis starts (reader, checksum, workers). The desktop app lowers their priority there: on Windows threads do not inherit it (D101).

§threads_ready: Option<Hook>

Runs once every thread the analysis needs is running, before counting. The command line starts its progress display there, so an optional thread never takes the place of one the run needs when the system limits threads (D110).

Implementations§

Source§

impl RunControl

Source

pub fn new() -> Self

A control block with fresh flags and the default thread count.

Source

pub fn with_threads(self, threads: NonZeroUsize) -> Self

Sets the number of worker threads.

Source

pub fn is_cancelled(&self) -> bool

true once cancellation was requested.

Source

pub fn check(&self) -> Result<()>

Err(Cancelled) once cancellation was requested.

§Errors

DimaError::Cancelled.

Source

pub fn thread_count(&self) -> NonZeroUsize

The worker-thread count: the explicit value, else the available parallelism (≥ 1).

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() -> RunControl

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

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

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