Skip to main content

WorkerContext

Struct WorkerContext 

Source
pub struct WorkerContext {
    pub info: WorkerInfo,
    pub cancellation: CancellationToken,
    pub deadline: Deadline,
}
Expand description

Cancellation and deadline state passed to worker lifecycle callbacks.

For persistent pools this context belongs to the pool lifetime: its token is cancelled only when the owner shuts the pool down. Dataset fetches and task transforms receive a separate, fresh context for each iterator generation.

use std::time::Duration;
use rusttorch_data::{
    CancellationToken, Deadline, LoaderCancelled, WaitOutcome,
    WorkerContext, WorkerInfo,
};

let cancellation = CancellationToken::new();
let context = WorkerContext::new(
    WorkerInfo::new(0, 1, 7, 0)?,
    cancellation.clone(),
    Deadline::none(),
);
assert!(context.check().is_ok());
let cancel = std::thread::spawn(move || cancellation.cancel());
assert_eq!(context.wait_cancelled_or_deadline(), WaitOutcome::Cancelled);
cancel.join().unwrap();
let _: LoaderCancelled = context.check().unwrap_err();

let expired = WorkerContext::new(
    WorkerInfo::new(0, 1, 7, 0)?,
    CancellationToken::new(),
    Deadline::after(Duration::ZERO),
);
assert_eq!(
    expired.wait_cancelled_or_deadline(),
    WaitOutcome::DeadlineExpired,
);

Fields§

§info: WorkerInfo

Stable worker identity and initialization seed.

§cancellation: CancellationToken

Cooperative cancellation token.

§deadline: Deadline

Dynamic monotonic deadline.

Implementations§

Source§

impl WorkerContext

Source

pub fn new( info: WorkerInfo, cancellation: CancellationToken, deadline: Deadline, ) -> Self

Creates a context from explicit worker information and controls.

Source

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

Returns an error when cancelled or expired.

Source

pub fn wait_cancelled_or_deadline(&self) -> WaitOutcome

Blocks until cancellation or deadline expiry.

Trait Implementations§

Source§

impl Clone for WorkerContext

Source§

fn clone(&self) -> WorkerContext

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 WorkerContext

Source§

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

Formats the value using the given formatter. 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> 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.

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