Struct CpuContext 

pub struct CpuContext { /* private fields */ }

Reusable CPU execution context carrying CPU parallelism policy.

CpuContext stores the requested thread count as a kernel-level parallelism hint and owns the Rayon pool used by multi-threaded CPU work.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::with_threads(1).unwrap();
let value = ctx.install(|| 1 + 1);
assert_eq!(value, 2);
assert_eq!(ctx.num_threads(), 1);

Implementations

impl CpuContext

pub fn from_env() -> Self

Create a CPU context from RAYON_NUM_THREADS, or fall back to the process-visible CPU count.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::from_env();
assert!(ctx.num_threads() >= 1);

pub fn try_from_env() -> Result<Self>

Try to create a CPU context from RAYON_NUM_THREADS.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::try_from_env()
    .unwrap_or_else(|_| CpuContext::with_threads(1).unwrap());
assert!(ctx.num_threads() >= 1);

pub fn with_threads(num_threads: usize) -> Result<Self>

Create a CPU context with a fixed parallelism hint.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::with_threads(2).unwrap();
assert_eq!(ctx.num_threads(), 2);

Errors

Returns an error when num_threads is zero or Rayon rejects the pool.

pub fn num_threads(&self) -> usize

Return this context’s CPU parallelism hint.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::with_threads(2).unwrap();
assert_eq!(ctx.num_threads(), 2);

pub fn install<R: Send>(&self, op: impl FnOnce() -> R + Send) -> R

Run a closure inside this context’s CPU execution scope.

Examples

use tenferro_cpu::CpuContext;

let ctx = CpuContext::with_threads(1).unwrap();
let value = ctx.install(|| 1 + 1);
assert_eq!(value, 2);

Trait Implementations

impl Clone for CpuContext

fn clone(&self) -> CpuContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CpuContext

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

Formats the value using the given formatter.