Skip to main content

State

trellis_runner

Struct State 

Source 
pub struct State<S: UserState> {
    pub user: S,
    /* private fields */
}
Expand description

Internal execution state of the solver.

This struct is owned exclusively by the Engine during execution and is not intended to be modified directly by users.

Access to state is provided through StateView.

§Fields

  • user: user-defined state implementing UserState
  • runtime: execution metadata (iteration count, duration)
  • convergence: convergence tracking for policies

Fields§

§user: S

The user component of the state implements the application specific code

Implementations§

Source§

impl<S> State<S>
where S: UserState, <S as UserState>::Float: FloatCore,

Source

pub fn run_summary(&self) -> RunSummary<<S as UserState>::Float>

Source

pub fn into_user(self) -> S

Trait Implementations§

Source§

impl<S: Clone + UserState> Clone for State<S>
where S::Float: Clone,

Source§

fn clone(&self) -> State<S>

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<S: Debug + UserState> Debug for State<S>
where S::Float: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for State<S>
where S: Freeze, <S as UserState>::Float: Freeze,

§

impl<S> RefUnwindSafe for State<S>
where S: RefUnwindSafe, <S as UserState>::Float: RefUnwindSafe,

§

impl<S> Send for State<S>
where S: Send, <S as UserState>::Float: Send,

§

impl<S> Sync for State<S>
where S: Sync, <S as UserState>::Float: Sync,

§

impl<S> Unpin for State<S>
where S: Unpin, <S as UserState>::Float: Unpin,

§

impl<S> UnsafeUnpin for State<S>
where S: UnsafeUnpin, <S as UserState>::Float: UnsafeUnpin,

§

impl<S> UnwindSafe for State<S>
where S: UnwindSafe, <S as UserState>::Float: 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 = 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.
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