Skip to main content

ResolvedPlanningConfig

Struct ResolvedPlanningConfig 

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

Fully resolved planning configuration.

§Examples

use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let policy = ExecutionPolicy::new(Determinism::Fast, Some(32), 5);
let config = ResolvedPlanningConfig::resolve(
    &policy,
    &PrepareOptions::new(),
    HardwareClassId::new("tenferro.cpu")?,
);
assert_eq!(config.hard_workspace_limit_bytes(), Some(32));

Implementations§

Source§

impl ResolvedPlanningConfig

Source

pub fn resolve( policy: &ExecutionPolicy, options: &PrepareOptions, hardware_class: HardwareClassId, ) -> Self

Resolve raw policy and per-call options into concrete planning config.

§Examples
use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let policy = ExecutionPolicy::new(Determinism::Fast, Some(32), 5);
let options = PrepareOptions::new().with_hard_workspace_limit_bytes(Some(0));
let config = ResolvedPlanningConfig::resolve(
    &policy,
    &options,
    HardwareClassId::new("tenferro.cpu")?,
);
assert_eq!(config.hard_workspace_limit_bytes(), Some(0));
Source

pub fn determinism(&self) -> Determinism

Return the resolved determinism mode.

§Examples
use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let config = ResolvedPlanningConfig::resolve(
    &ExecutionPolicy::new(Determinism::Reproducible, None, 0),
    &PrepareOptions::new(),
    HardwareClassId::new("tenferro.cpu")?,
);
assert_eq!(config.determinism(), Determinism::Reproducible);
Source

pub fn hard_workspace_limit_bytes(&self) -> Option<usize>

Return the resolved hard workspace limit.

§Examples
use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let config = ResolvedPlanningConfig::resolve(
    &ExecutionPolicy::new(Determinism::Fast, Some(7), 0),
    &PrepareOptions::new(),
    HardwareClassId::new("tenferro.cpu")?,
);
assert_eq!(config.hard_workspace_limit_bytes(), Some(7));
Source

pub fn planning_seed(&self) -> u64

Return the resolved planning seed.

§Examples
use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let config = ResolvedPlanningConfig::resolve(
    &ExecutionPolicy::new(Determinism::Fast, None, 19),
    &PrepareOptions::new(),
    HardwareClassId::new("tenferro.cpu")?,
);
assert_eq!(config.planning_seed(), 19);
Source

pub fn hardware_class(&self) -> &HardwareClassId

Return the resolved hardware class.

§Examples
use tenferro_runtime::{
    Determinism, ExecutionPolicy, HardwareClassId, PrepareOptions, ResolvedPlanningConfig,
};

let hardware = HardwareClassId::new("tenferro.cpu")?;
let config = ResolvedPlanningConfig::resolve(
    &ExecutionPolicy::new(Determinism::Fast, None, 0),
    &PrepareOptions::new(),
    hardware.clone(),
);
assert_eq!(config.hardware_class(), &hardware);

Trait Implementations§

Source§

impl Clone for ResolvedPlanningConfig

Source§

fn clone(&self) -> ResolvedPlanningConfig

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 ResolvedPlanningConfig

Source§

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

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

impl Hash for ResolvedPlanningConfig

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ResolvedPlanningConfig

Source§

fn eq(&self, other: &ResolvedPlanningConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for ResolvedPlanningConfig

Source§

impl StructuralPartialEq for ResolvedPlanningConfig

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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> 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> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,