Enum OcpiError 

#[non_exhaustive]
pub enum OcpiError {
    Remote {
        status_code: StatusCode,
        status_message: Option<String>,
    },
    MissingData {
        status_code: StatusCode,
    },
    MalformedJson(String),
    Decode {
        path: String,
        message: String,
    },
    Invalid(Violations),
    Unauthorized(String),
    TokenAOutOfScope,
    NotFound(String),
    MethodNotAllowed(String),
    Transport(String),
    NotRoutable(String),
    Unsupported(String),
    UrlRefused {
        url: String,
        reason: String,
    },
}

Available on crate feature transport only.

Everything that can go wrong on an OCPI request, from either side of the wire.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Remote

The peer answered with a non-success OCPI status code.

Fields

status_code: StatusCode

The code the peer sent.

status_message: Option<String>

The message the peer sent, if any.

MissingData

A successful response did not carry the payload the endpoint documents.

Fields

status_code: StatusCode

The code the peer sent.

MalformedJson(String)

The request body was not valid JSON, so it never reached the OCPI layer.

When a message does not contain a valid JSON string, the HTTP error 400 - Bad request MUST be returned.

Decode

The body was valid JSON but did not fit the OCPI object it was supposed to be.

path is the JSON path to the offending value, which is what turns a support ticket into a one-line fix.

Fields

path: String

JSON path to the value that did not decode.

message: String

What went wrong there.

Invalid(Violations)

A decoded object broke rules of the specification.

Unauthorized(String)

No credentials token, or one that matches no known party.

If the header is missing or the credentials token doesn’t match any known party then the server SHALL respond with an HTTP 401 - Unauthorized status code.

TokenAOutOfScope

CREDENTIALS_TOKEN_A was used on a module other than credentials or versions.

the server SHALL respond with an HTTP 401 - Unauthorized status code.

NotFound(String)

A GET addressed a resource that does not exist.

In case of a GET request, when the resource does NOT exist, the server SHOULD return a HTTP 404 - Not Found.

MethodNotAllowed(String)

The HTTP method is not allowed in the current registration state.

The credentials module uses this: POST when already registered, PUT or DELETE when not.

Transport(String)

The transport failed: connection refused, TLS failure, timeout, non-JSON body.

NotRoutable(String)

A hub was asked to route a request whose headers and method do not describe any of the scenarios the specification defines.

The clearest example is a GET addressed to the hub’s own party on a Receiver interface: the OCPI-to- headers say Broadcast Push, but “GET SHALL NOT be used in combination with Broadcast Push”, and the sender is told to use an Open Routing Request instead.

Spec: 2.3.0 §transport_and_format_message_routing

Unsupported(String)

This build cannot carry a document between the two OCPI versions involved.

A client whose peer speaks a version this crate has no conversions for, or a merge patch that writes a field the two versions disagree about. It is a 3000 rather than a 2001 because nothing about the request is wrong: the software simply cannot do it.

UrlRefused

A URL was refused by the configured UrlPolicy.

Fields

url: String

The URL that was refused.

reason: String

Why it was refused.

Implementations

impl OcpiError

pub fn status_code(&self) -> StatusCode

The OCPI status code this error should be reported as.

pub const fn http_status(&self) -> u16

The HTTP status code this error should be answered with.

This encodes the whole of §status_codes: the only cases that get an HTTP error are the ones the spec explicitly names. Everything that reached the OCPI layer is HTTP 200 with a 2xxx/3xxx/4xxx status_code in the body.

Situation	HTTP
body is not valid JSON	400
missing or unknown credentials token	401
CREDENTIALS_TOKEN_A outside credentials/versions	401
GET of a resource that does not exist	404
credentials POST when registered, PUT/DELETE when not	405
anything else	200

Spec: 2.3.0 §status_codes_status_codes

pub fn is_transient(&self) -> bool

Whether retrying the same request could plausibly succeed.

The spec forbids automatically retrying a write:

OCPI messages SHOULD NOT be queued. When a client does a POST, PUT or PATCH request and that request fails or times out, the client should not queue the message and retry the same message again later.

So this is only ever consulted for GETs; see RetryPolicy.

pub fn to_response<T>(&self) -> OcpiResponse<T>

Renders this error as the envelope a server should send back.

Trait Implementations

impl Debug for OcpiError

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

Formats the value using the given formatter.

impl Display for OcpiError

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

Formats the value using the given formatter.

impl Error for OcpiError

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<OcpiError> for OcpiErrorResponse

Available on crate feature server only.

fn from(error: OcpiError) -> Self

Converts to this type from the input type.

impl From<Violations> for OcpiError

fn from(source: Violations) -> Self

Converts to this type from the input type.

impl IntoResponse for OcpiError

Available on crate feature server only.

fn into_response(self) -> Response

Create a response.