Enum BojError 

pub enum BojError {
    ValidationError(String),
    DecodeError(String),
    TransportError(String),
    ApiError {
        status: u16,
        message_id: String,
        message: String,
    },
}

Error type returned by the BOJ client.

Examples

use boj_client::error::BojError;

let error = BojError::validation("invalid parameter");
assert!(matches!(error, BojError::ValidationError(_)));

Variants

ValidationError(String)

Input validation failed before sending a request.

DecodeError(String)

Response decoding failed for JSON/CSV payloads.

TransportError(String)

Transport-level failure (network, HTTP client, invalid request shape).

ApiError

API-level error represented by BOJ status and message fields.

Fields

status: u16

BOJ STATUS value.

message_id: String

BOJ MESSAGE-ID value.

message: String

BOJ MESSAGE value.

Implementations

impl BojError

pub fn validation(message: impl Into<String>) -> Self

Creates BojError::ValidationError.

Examples

use boj_client::error::BojError;

let error = BojError::validation("invalid db");
assert!(matches!(error, BojError::ValidationError(_)));

pub fn decode(message: impl Into<String>) -> Self

Creates BojError::DecodeError.

Examples

use boj_client::error::BojError;

let error = BojError::decode("invalid JSON");
assert!(matches!(error, BojError::DecodeError(_)));

pub fn transport(message: impl Into<String>) -> Self

Creates BojError::TransportError.

Examples

use boj_client::error::BojError;

let error = BojError::transport("timeout");
assert!(matches!(error, BojError::TransportError(_)));

pub fn api( status: u16, message_id: impl Into<String>, message: impl Into<String>, ) -> Self

Creates BojError::ApiError.

Examples

use boj_client::error::BojError;

let error = BojError::api(500, "M181090S", "internal");
assert!(matches!(error, BojError::ApiError { status: 500, .. }));

Trait Implementations

impl Clone for BojError

fn clone(&self) -> BojError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BojError

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

Formats the value using the given formatter.

impl Display for BojError

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

Formats the value using the given formatter.

impl Error for BojError

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 PartialEq for BojError

fn eq(&self, other: &BojError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BojError

impl StructuralPartialEq for BojError