Struct StatusCode 

pub struct StatusCode(/* private fields */);

Available on crate feature transport only.

A four-digit OCPI status code.

Modelled as a newtype over u16 rather than an enum because the spec reserves custom ranges (19xx, 29xx, 39xx, 49xx) that a party may define values in, and because a peer may send a code from a newer version.

use ocpi_kit::transport::{StatusCode, StatusClass};

assert_eq!(StatusCode::SUCCESS.class(), StatusClass::Success);
assert_eq!(StatusCode::INVALID_PARAMETERS.get(), 2001);
assert!(StatusCode::new(2901).is_custom());

Spec: 2.3.0 §status_codes_status_codes

Implementations

impl StatusCode

pub const SUCCESS: Self

1000 — Generic success code.

pub const CLIENT_ERROR: Self

2000 — Generic client error.

pub const INVALID_PARAMETERS: Self

2001 — Invalid or missing parameters, e.g. a missing last_updated in a PATCH.

pub const NOT_ENOUGH_INFORMATION: Self

2002 — Not enough information, e.g. an authorization request with too little information.

pub const UNKNOWN_LOCATION: Self

2003 — Unknown Location, e.g. a START_SESSION with an unknown location.

pub const UNKNOWN_TOKEN: Self

2004 — Unknown Token, e.g. a real-time authorization of an unknown Token.

pub const SERVER_ERROR: Self

3000 — Generic server error.

pub const UNABLE_TO_USE_CLIENT_API: Self

3001 — Unable to use the client’s API, e.g. a failed call-back during registration.

pub const UNSUPPORTED_VERSION: Self

3002 — Unsupported version.

pub const NO_MATCHING_ENDPOINTS: Self

3003 — No matching endpoints or expected endpoints missing between parties.

pub const HUB_ERROR: Self

4000 — Generic hub error.

pub const UNKNOWN_RECEIVER: Self

4001 — Unknown receiver: the OCPI-to-* address is unknown.

pub const TIMEOUT_ON_FORWARDED_REQUEST: Self

4002 — Timeout on a forwarded request.

pub const CONNECTION_PROBLEM: Self

4003 — Connection problem: the receiving party is not connected.

pub const fn new(code: u16) -> Self

Wraps a raw code.

pub const fn get(self) -> u16

The raw code.

pub const fn class(self) -> StatusClass

Which of the four ranges this code falls in.

pub const fn is_success(self) -> bool

Whether this is a success code, so data carries the documented payload.

When the status code is in the success range (1xxx), the data field in the response message SHOULD contain the information as specified in the protocol. Otherwise the data field is unspecified.

pub const fn is_custom(self) -> bool

Whether the code falls in one of the reserved custom sub-ranges (x900–x999).

Custom status code range values SHALL NOT be used by standard OCPI module … When custom status codes are used, keep in mind that different custom modules could use the same values with a different meaning, as they are not standardized.

pub const fn description(self) -> Option<&'static str>

The description the specification gives for this code, when it defines one.

Trait Implementations

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StatusCode

impl Debug for StatusCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatusCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StatusCode

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

Formats the value using the given formatter.

impl Eq for StatusCode

impl From<StatusCode> for u16

fn from(value: StatusCode) -> Self

Converts to this type from the input type.

impl From<u16> for StatusCode

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for StatusCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for StatusCode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for StatusCode

fn cmp(&self, other: &StatusCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for StatusCode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StatusCode

fn partial_cmp(&self, other: &StatusCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for StatusCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StatusCode