Skip to main content

StateView

Struct StateView 

Source
pub struct StateView<'a, S: UserState> { /* private fields */ }
Expand description

Read-only view into engine state at a single point in time.

This type is used by:

  • observers
  • logging systems
  • extensions
  • external monitoring hooks

It provides safe immutable access without exposing ownership of the underlying State<S>.

Implementations§

Source§

impl<'a, S> StateView<'a, S>
where S: UserState, <S as UserState>::Float: FloatCore,

Source

pub fn iteration(&self) -> usize

Current iteration number of the engine.

Source

pub fn duration(&self) -> Duration

Total elapsed execution duration.

Source

pub fn best_measure(&self) -> S::Float

Best convergence value observed so far.

Source

pub fn current_measure(&self) -> S::Float

Current convergence value.

Source

pub fn iterations_since_best(&self) -> usize

Number of iterations since the last improvement.

Source

pub fn user<'b>(&'b self) -> &'a S

Access to user-defined state (read-only).

Trait Implementations§

Source§

impl<'a, S: UserState> Clone for StateView<'a, S>

Source§

fn clone(&self) -> Self

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<'a, S: UserState> Copy for StateView<'a, S>

Auto Trait Implementations§

§

impl<'a, S> Freeze for StateView<'a, S>
where &'a State<S>: Freeze,

§

impl<'a, S> RefUnwindSafe for StateView<'a, S>
where &'a State<S>: RefUnwindSafe,

§

impl<'a, S> Send for StateView<'a, S>
where &'a State<S>: Send,

§

impl<'a, S> Sync for StateView<'a, S>
where &'a State<S>: Sync,

§

impl<'a, S> Unpin for StateView<'a, S>
where &'a State<S>: Unpin,

§

impl<'a, S> UnsafeUnpin for StateView<'a, S>
where &'a State<S>: UnsafeUnpin,

§

impl<'a, S> UnwindSafe for StateView<'a, S>
where &'a State<S>: UnwindSafe,

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<Proc> GenerateBuilder for Proc

Source§

fn build_for<P>(self, problem: P) -> Builder<Infallible<Proc>, P, Uninitialised>
where Proc: Procedure<P>, <Proc as Procedure<P>>::State: UserState,

Source§

impl<Proc> GenerateBuilderFallible for Proc

Source§

fn build_for<P>(self, problem: P) -> Builder<Proc, P, Uninitialised>
where Proc: FallibleProcedure<P>, <Proc as FallibleProcedure<P>>::State: UserState,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more