Skip to main content

RefinementRuntime

Struct RefinementRuntime 

Source
pub struct RefinementRuntime<C = ()> { /* private fields */ }
Expand description

Stateful method-independent refinement boundary guard.

Implementations§

Source§

impl<C> RefinementRuntime<C>

Source

pub fn new( limits: RefinementLimits, cancellation: Option<CancellationToken>, ) -> Result<Self, RuntimeError>

Construct a runtime with a process-local monotonic clock.

§Errors

Returns RuntimeError::InvalidClock if the clock origin is invalid.

Source

pub fn with_clock( limits: RefinementLimits, cancellation: Option<CancellationToken>, clock: Arc<dyn RuntimeClock>, ) -> Result<Self, RuntimeError>

Construct a runtime with an injectable thread-safe clock.

§Errors

Returns RuntimeError::InvalidClock if the first timestamp is non-finite.

Source

pub fn set_event_sink(&mut self, sink: impl RefinementEventSink + 'static)

Attach a synchronous event sink. Sink failures are isolated and recorded.

Source

pub fn set_checkpoint_sink(&mut self, sink: impl CheckpointSink<C> + 'static)

Attach an application-owned typed checkpoint sink.

Source

pub fn resume_accepted( &mut self, completed_iterations: usize, ) -> Result<(), RuntimeError>

Restore accepted/attempted counters from a validated checkpoint.

Evaluation and rejection budgets restart for the continuation call.

§Errors

Returns RuntimeError::InvalidResume if work already began or the completed count exceeds the iteration budget.

Source

pub fn elapsed_seconds(&self) -> Result<f64, RuntimeError>

Return finite non-negative elapsed seconds.

§Errors

Returns RuntimeError::InvalidClock for non-finite or backward time.

Source

pub fn emit( &mut self, kind: RefinementEventKind, stage: impl Into<String>, message: impl Into<String>, diagnostics: Vec<(String, DiagnosticValue)>, ) -> Result<RefinementEvent, RuntimeError>

Emit one validated event and isolate a failing event sink.

§Errors

Returns RuntimeError for clock or event validation failures. A sink failure does not invalidate numerical state and is stored separately.

Source

pub fn check_boundary(&self) -> Result<(), RuntimeError>

Stop at a safe boundary for cancellation, time, or evaluation budget.

§Errors

Returns RuntimeError::Stopped for a normal bounded stop, or a clock/ cancellation-state error.

Source

pub fn begin_iteration( &mut self, attempted_iteration: usize, ) -> Result<(), RuntimeError>

Begin one strictly increasing attempted iteration.

§Errors

Returns RuntimeError for order violations or a normal bounded stop.

Source

pub fn begin_evaluation(&mut self) -> Result<(), RuntimeError>

Reserve one model evaluation after checking every safe-boundary budget.

§Errors

Returns RuntimeError for a normal bounded stop or invalid clock/token.

Source

pub fn accept_step( &mut self, checkpoint: Option<&C>, ) -> Result<(), RuntimeError>

Accept at most one step in the current attempted iteration.

State becomes accepted before the optional checkpoint sink is called, so a sink failure never rolls numerical state backward.

§Errors

Returns RuntimeError for acceptance-order, counter, checkpoint, event, or clock failures.

Source

pub fn reject_step(&mut self) -> Result<(), RuntimeError>

Record a rejection and enforce its consecutive budget.

§Errors

Returns RuntimeError::Stopped when the rejection limit is reached.

Source

pub const fn attempted_iteration(&self) -> usize

Return the attempted iteration counter.

Source

pub const fn accepted_iterations(&self) -> usize

Return the accepted iteration counter.

Source

pub const fn evaluations(&self) -> usize

Return the model-evaluation counter.

Source

pub const fn consecutive_rejections(&self) -> usize

Return consecutive rejected steps since the last acceptance.

Source

pub fn event_sink_error(&self) -> Option<&str>

Borrow the isolated event-sink error, if any.

Source

pub const fn has_event_sink(&self) -> bool

Return whether an event sink remains attached.

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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.