Skip to main content

EngineSignal

trellis_runner

Enum EngineSignal 

Source 
pub enum EngineSignal<F> {
    Initialised,
    Progress(Progress<F>),
    Iterated,
    CheckpointSaved,
    CheckpointRequested(CheckpointReason),
    Termination(Termination),
}
Expand description

High-level lifecycle events emitted by the engine.

These events are used for:

  • observers / logging
  • external monitoring
  • UI updates

They are distinct from Progress, which represents numerical solver signals.

Variants§

§

Initialised

Engine has completed initialisation and is ready to iterate.

§

Progress(Progress<F>)

A single progress signal emitted during iteration.

§

Iterated

Engine has completed a single iteration

§

CheckpointSaved

A checkpoint has been successfully persisted.

§

CheckpointRequested(CheckpointReason)

A checkpoint has been requested.

§

Termination(Termination)

Engine has terminated for any reason.

Implementations§

Source§

impl<F> EngineSignal<F>

Source

pub fn as_tag(&self) -> &'static str

Returns a stable string tag identifying the event kind.

Trait Implementations§

Source§

impl<F: Debug> Debug for EngineSignal<F>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F> Freeze for EngineSignal<F>
where Progress<F>: Freeze,

§

impl<F> RefUnwindSafe for EngineSignal<F>
where Progress<F>: RefUnwindSafe,

§

impl<F> Send for EngineSignal<F>
where Progress<F>: Send,

§

impl<F> Sync for EngineSignal<F>
where Progress<F>: Sync,

§

impl<F> Unpin for EngineSignal<F>
where Progress<F>: Unpin,

§

impl<F> UnsafeUnpin for EngineSignal<F>
where Progress<F>: UnsafeUnpin,

§

impl<F> UnwindSafe for EngineSignal<F>
where Progress<F>: 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> 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, 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