Enum BurnCentralError 

pub enum BurnCentralError {
    InvalidExperimentPath(String),
    InvalidProjectPath(String),
    InvalidExperimentNumber(String),
    InvalidModelPath(String),
    Client {
        context: String,
        source: ClientError,
    },
    ExperimentTracker(ExperimentTrackerError),
    Unauthenticated,
    Io(Error),
    Internal(String),
}

Errors that can occur during when using the BurnCentral client.

Those errors should be handled by the user of this library. If he want to implement fallback behavior or retry logic.

Variants

InvalidExperimentPath(String)

Input validation errors

InvalidProjectPath(String)

This error occurs when the provided project path is invalid. It is a input validation errors. No API call has been made yet.

InvalidExperimentNumber(String)

This error occurs when the provided experiment number is invalid. It is a input validation errors. No API call has been made yet.

InvalidModelPath(String)

This error occurs when the provided model path is invalid. It is a input validation errors. No API call has been made yet.

Client

Represents an error related to client operations.

This error variant is used to encapsulate client-specific errors along with additional context and the underlying source error for more detailed debugging.

Fields

• context (String): A description or additional information about the client error context.
• source (ClientError): The underlying source of the client error, providing more details about the cause.

Fields

context: String

source: ClientError

ExperimentTracker(ExperimentTrackerError)

Represents an error related to the experiment tracker. Those errors are coming from the websocket connection that open when starting an experiment run.

Unauthenticated

Error that should be used when the user is not logged in but tries to perform an operation that requires authentication.

Io(Error)

Error that should be used when the client performs operations that can fail due to IO issues.

Internal(String)

Error that should be used when the client encounters an error that is not specifically handled.

Trait Implementations

impl Debug for BurnCentralError

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

Formats the value using the given formatter.

impl Display for BurnCentralError

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

Formats the value using the given formatter.

impl Error for BurnCentralError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for BurnCentralError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ExperimentTrackerError> for BurnCentralError

fn from(source: ExperimentTrackerError) -> Self

Converts to this type from the input type.