Struct PrepareOptions 

pub struct PrepareOptions { /* private fields */ }

Per-prepare request options before runtime normalization.

Raw options intentionally do not implement Hash; normalized keys are created only after placement and planning resolution.

Examples

use tenferro_runtime::PrepareOptions;

assert!(PrepareOptions::new().planning_seed().is_none());

Implementations

impl PrepareOptions

pub fn new() -> Self

Return default prepare options.

Examples

use tenferro_runtime::{CacheInFlightBehavior, PrepareOptions};

let options = PrepareOptions::new();
assert_eq!(options.cache_in_flight(), CacheInFlightBehavior::Wait);

pub fn with_placement(self, placement: ProgramPlacementConstraint) -> Self

Set the placement constraint.

Examples

use tenferro_runtime::{PrepareOptions, ProgramPlacementConstraint};

let placement = ProgramPlacementConstraint::any();
let options = PrepareOptions::new().with_placement(placement.clone());
assert_eq!(options.placement(), Some(&placement));

pub fn with_hard_workspace_limit_bytes(self, limit: Option<usize>) -> Self

Set or reset the per-call workspace override.

Passing None resets the field to inherit the policy value.

Examples

use tenferro_runtime::PrepareOptions;

let options = PrepareOptions::new().with_hard_workspace_limit_bytes(Some(0));
assert_eq!(options.hard_workspace_limit_bytes(), Some(0));
assert_eq!(options.with_hard_workspace_limit_bytes(None).hard_workspace_limit_bytes(), None);

pub fn with_planning_seed(self, seed: u64) -> Self

Set the per-call planning seed override.

Examples

use tenferro_runtime::PrepareOptions;

assert_eq!(PrepareOptions::new().with_planning_seed(3).planning_seed(), Some(3));

pub fn with_cache_in_flight(self, behavior: CacheInFlightBehavior) -> Self

Set the in-flight cache behavior for this request.

Examples

use tenferro_runtime::{CacheInFlightBehavior, PrepareOptions};

let options = PrepareOptions::new().with_cache_in_flight(CacheInFlightBehavior::Refuse);
assert_eq!(options.cache_in_flight(), CacheInFlightBehavior::Refuse);

pub fn placement(&self) -> Option<&ProgramPlacementConstraint>

Return the raw placement constraint, if supplied.

Examples

use tenferro_runtime::{PrepareOptions, ProgramPlacementConstraint};

let placement = ProgramPlacementConstraint::any();
let options = PrepareOptions::new().with_placement(placement.clone());
assert_eq!(options.placement(), Some(&placement));

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

Return the raw per-call workspace override.

Examples

use tenferro_runtime::PrepareOptions;

assert_eq!(
    PrepareOptions::new().with_hard_workspace_limit_bytes(Some(16)).hard_workspace_limit_bytes(),
    Some(16)
);

pub fn planning_seed(&self) -> Option<u64>

Return the raw per-call planning seed override.

Examples

use tenferro_runtime::PrepareOptions;

assert_eq!(PrepareOptions::new().with_planning_seed(9).planning_seed(), Some(9));

pub fn cache_in_flight(&self) -> CacheInFlightBehavior

Return the request’s in-flight cache behavior.

Examples

use tenferro_runtime::{CacheInFlightBehavior, PrepareOptions};

assert_eq!(PrepareOptions::new().cache_in_flight(), CacheInFlightBehavior::Wait);

Trait Implementations

impl Clone for PrepareOptions

fn clone(&self) -> PrepareOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrepareOptions

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

Formats the value using the given formatter.

impl Default for PrepareOptions

fn default() -> PrepareOptions

Returns the “default value” for a type.

impl PartialEq for PrepareOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for PrepareOptions

impl StructuralPartialEq for PrepareOptions