Enum ObjectiveError 

pub enum ObjectiveError {
    Pruned,
    Failed(Box<dyn Error + Send + Sync>),
}

Signalled by a user objective to describe how a trial ended.

Returning Ok(value) completes the trial; returning one of these marks it Pruned or Failed without aborting the whole study. A blanket From makes ? on any standard error turn into ObjectiveError::Failed, while ObjectiveError::pruned is used to bail out after should_prune().

Variants

Pruned

The trial was stopped early by a pruner. Marked crate::TrialState::Pruned.

Failed(Box<dyn Error + Send + Sync>)

The objective failed. Marked crate::TrialState::Failed; the study continues.

Implementations

impl ObjectiveError

pub fn pruned() -> ObjectiveError

Convenience constructor for the pruned case: if ctx.should_prune() { return Err(ObjectiveError::pruned()); }.

Trait Implementations

impl Debug for ObjectiveError

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

Formats the value using the given formatter.

impl Display for ObjectiveError

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

Formats the value using the given formatter.

impl<E> From<E> for ObjectiveError

where E: Error + Send + Sync + 'static,

fn from(e: E) -> ObjectiveError

Converts to this type from the input type.