Enum Error 

pub enum Error {
    ServerAlreadyStarted(u16),
    ServerNotStarted,
    PortInUse(u16),
    PortDiscoveryFailed(String),
    InvalidConfig(String),
    InvalidStub(String),
    StubNotFound {
        method: String,
        path: String,
        available: String,
    },
    Http(Error),
    Io(Error),
    Json(Error),
    Core(Error),
    StartupTimeout {
        timeout_secs: u64,
    },
    ShutdownTimeout {
        timeout_secs: u64,
    },
    AdminApiError {
        operation: String,
        message: String,
        endpoint: String,
    },
    General(String),
}

SDK Error types

Variants

ServerAlreadyStarted(u16)

Server already started

ServerNotStarted

Server not started

PortInUse(u16)

Port already in use

PortDiscoveryFailed(String)

Port discovery failed

InvalidConfig(String)

Invalid configuration

InvalidStub(String)

Invalid stub

StubNotFound

Stub not found

Fields

method: String

HTTP method that was requested

path: String

Path that was requested

available: String

Comma-separated list of available stubs

Http(Error)

HTTP error

Io(Error)

IO error

Json(Error)

JSON serialization error

Core(Error)

MockForge core error

StartupTimeout

Server startup timeout

Fields

timeout_secs: u64

Number of seconds waited before timeout

ShutdownTimeout

Server shutdown timeout

Fields

timeout_secs: u64

Number of seconds waited before timeout

AdminApiError

Admin API error

Fields

operation: String

The operation that failed (e.g., “create_mock”, “list_mocks”)

message: String

The error message from the server or client

endpoint: String

The API endpoint that was called

General(String)

General error

Implementations

impl Error

pub fn admin_api_error( operation: impl Into<String>, message: impl Into<String>, endpoint: impl Into<String>, ) -> Self

Create an admin API error with context

Examples

use mockforge_sdk::Error;

let err = Error::admin_api_error(
    "create_mock",
    "Invalid JSON",
    "/api/mocks"
);

pub fn stub_not_found( method: impl Into<String>, path: impl Into<String>, available: Vec<String>, ) -> Self

Create a stub not found error with available stubs

Examples

use mockforge_sdk::Error;

let err = Error::stub_not_found(
    "GET",
    "/api/missing",
    vec!["GET /api/users".to_string()]
);

pub fn to_log_string(&self) -> String

Format error for logging (single line, no ANSI colors)

Useful for structured logging where multi-line messages aren’t desired.

Examples

use mockforge_sdk::Error;

let err = Error::ServerNotStarted;
let log_msg = err.to_log_string();
// Use in logging: log::error!("{}", log_msg);

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.