Struct Domain 

pub struct Domain { /* private fields */ }

A P0 execution domain.

Domain::sequential creates domain zero with one worker and no Rayon pool. At most one coarse operation may be admitted at a time; Domain::try_admit returns DomainBusy immediately instead of waiting when another operation owns the domain.

Example

use hataori::{Domain, DomainBusy};

let domain = Domain::sequential();
let admission = domain.try_admit().unwrap();
assert_eq!(domain.try_admit().unwrap_err(), DomainBusy);
drop(admission);
assert!(domain.try_admit().is_ok());

Implementations

impl Domain

pub fn sequential() -> Self

Creates the P0 sequential domain: ID zero, one worker, and no running operation.

pub const fn id(&self) -> DomainId

Returns the domain identifier.

pub const fn worker_count(&self) -> usize

Returns the declared worker count.

pub fn try_admit(&self) -> Result<DomainAdmission<'_>, DomainBusy>

Attempts to admit one coarse operation without waiting.

pub fn managed( cpu_set: Vec<usize>, worker_count: usize, ) -> Result<Self, DomainBuildError>

Creates and owns a Rayon pool, verifying worker affinity on Linux.

pub fn external( pool: Arc<ThreadPool>, declared_cpu_set: Vec<usize>, worker_count: usize, ) -> Result<Self, DomainBuildError>

Uses a caller-owned Rayon pool without changing its worker affinity or shutting it down when this domain is dropped.

pub fn cpu_set(&self) -> Option<&[usize]>

Returns the declared or verified CPU set, when this domain has a pool.

pub fn pool_ownership(&self) -> Option<PoolOwnership>

Returns the pool ownership mode, when this domain has a pool.

pub fn placement_status(&self) -> Option<PlacementStatus>

Returns the placement status, when this domain has a pool.

pub fn rayon_pool_handle(&self) -> Option<Arc<ThreadPool>>

Clones the Rayon pool handle associated with this domain, when present.

This grants no domain admission. Submitting work directly to the returned pool bypasses Hataori scheduling; integration adapters must enter through an already admitted LocalMode::Inner callback.

Examples

use hataori::Domain;
use std::sync::Arc;

let pool = Arc::new(rayon::ThreadPoolBuilder::new().num_threads(1).build().unwrap());
let domain = Domain::external(Arc::clone(&pool), vec![0], 1).unwrap();
assert!(Arc::ptr_eq(&pool, &domain.rayon_pool_handle().unwrap()));

Trait Implementations

impl Debug for Domain

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

Formats the value using the given formatter.