Struct Control 

pub struct Control<'a> { /* private fields */ }

How a caller stops an operation: a poll, a budget of steps, both or neither. Every operation on a model, and every long query beside one, takes one last; Control::NONE is what a caller that does not care passes.

A step is one iteration of a loop whose trip count is not bounded by the input’s entity count (ADR-0030 §5). Step counts are stable within one release, not across releases: a budget is a cap a caller tunes.

use arris_math::{Control, Meter, Stop};
use core::sync::atomic::{AtomicBool, Ordering};

let stop = AtomicBool::new(false);
let poll = || stop.load(Ordering::Relaxed);
let control = Control::poll(&poll).with_budget(2);
let mut meter = Meter::new(&control);
assert!(meter.tick().is_ok() && meter.tick().is_ok());
let spent = meter.tick().unwrap_err();
assert_eq!((spent.by, spent.steps), (Stop::Budget, 2));

stop.store(true, Ordering::Relaxed);
let stopped = Meter::new(&control).tick().unwrap_err();
assert_eq!((stopped.by, stopped.steps), (Stop::Poll, 0));

Implementations

impl Control<'static>

pub const NONE: Control<'static>

No poll and no budget: the operation runs to its end.

pub const fn budget(steps: u64) -> Control<'static>

A budget of steps and no poll: the steps + 1-th step is Stop::Budget.

impl<'a> Control<'a>

pub const fn poll(poll: Poll<'a>) -> Control<'a>

A poll and no budget. The poll is asked at every step, and a true stops the operation at that step.

pub const fn with_budget(self, steps: u64) -> Self

This control with a budget of steps.

pub const fn with_poll(self, poll: Poll<'a>) -> Self

This control with poll.

Trait Implementations

impl<'a> Clone for Control<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Control<'a>

impl Debug for Control<'_>

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

Formats the value using the given formatter.

impl<'a> Default for Control<'a>

fn default() -> Self

Returns the “default value” for a type.