Enum ModuleId 

#[non_exhaustive]
pub enum ModuleId {
    Cdrs,
    ChargingProfiles,
    Commands,
    Credentials,
    HubClientInfo,
    Locations,
    Payments,
    Sessions,
    Tariffs,
    Tokens,
    Versions,
    Booking,
    InvoiceReconciliation,
    Custom(String),
}

The identifier of an OCPI module, as used in Endpoint.identifier.

Parties are allowed to create custom modules or customized versions of the existing modules. To do so, the ModuleID enum can be extended with additional custom moduleIDs. … It is advised to use a prefix (e.g. country-code + party-id) for any custom moduleID.

So ModuleId::Custom("nltnm-tokens") is a legitimate value, not an error.

Spec: 2.3.0 §version_information_endpoint_moduleid_enum

This is an OCPI OpenEnum: a value this version of the specification does not define is a legitimate extension, and Validate does not report it.

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.

Cdrs

Charge Detail Records. Sender: CPO.

Wire value: cdrs

ChargingProfiles

Smart charging profiles.

Wire value: chargingprofiles

Commands

Remote commands: start, stop, reserve, unlock.

Wire value: commands

Credentials

Credentials and registration. Required for all implementations.

Wire value: credentials

HubClientInfo

Hub client info: which parties a hub has connected.

Wire value: hubclientinfo

Locations

Charging locations, EVSEs and connectors. Sender: CPO.

Wire value: locations

Payments

Payment terminals and financial advice confirmations. Sender: PTP.

Added to the protocol in OCPI 2.3.0.

Spec erratum. The Payments module chapter gives “Module Identifier: payments”, but the module is missing from the ModuleID table in §version_information_endpoint_moduleid_enum of the same release. The chapter is normative for its own identifier, so payments is treated as a known module here.

Wire value: payments

Sessions

Charging sessions. Sender: CPO.

Wire value: sessions

Tariffs

Tariffs. Sender: CPO.

Wire value: tariffs

Tokens

Driver tokens and real-time authorization. Sender: eMSP.

Wire value: tokens

Versions

Versions and version details. Every implementation has this, but it is not listed as an endpoint inside version details.

Wire value: versions

Booking

Bookings, from the OCPI 2.3.0 bookings release branch.

Spec quirk. The identifier really is Booking: singular, and the only module ID in OCPI that is not lower-case. Every other module uses a lower-case plural. It is also absent from that branch’s ModuleID table. Peers that guessed bookings exist; see ModuleId::matches.

Wire value: Booking

InvoiceReconciliation

Invoice reconciliation, from the OCPI 2.3.0 payments release branch.

Wire value: invoicereconciliation

Custom(String)

A value this version of the specification does not define, preserved verbatim.

The variant is named Custom rather than Other because several OCPI OpenEnums have a defined value that is literally OTHER.

Implementations

impl ModuleId

pub const ALL_KNOWN: &'static [Self]

Every value this version of the specification defines, in declaration order.

pub const ALL_KNOWN_WIRE: &'static [&'static str]

Every wire value this version of the specification defines.

pub fn as_str(&self) -> &str

The value as it appears on the wire.

pub const fn is_known(&self) -> bool

Whether this is a value the specification defines.

pub fn from_str_ignore_case(s: &str) -> Self

Parses a wire value, ignoring ASCII case for the known values.

For peers that get the case wrong; FromStr is strict.

impl ModuleId

pub const fn is_functional(&self) -> bool

Whether this module carries the message routing headers.

Only requests/responses from Function Modules … SHALL be routed, so need the routing headers. The requests/responses to/from Configuration Modules: Credentials, Versions and Hub Client Info are not to be routed … Thus routing headers SHALL NOT be used with these modules.

A custom module is assumed to be functional, since that is what a party would define one for.

Spec: 2.3.0 §transport_and_format_message_routing

pub const fn is_configuration(&self) -> bool

Whether this is one of the three configuration modules, which are never routed.

Spec: 2.3.0 §transport_and_format_message_routing

pub fn matches(&self, other: &Self) -> bool

Compares module identifiers the way a tolerant peer would.

Two accommodations, both narrow and both deliberate:

• ASCII case is ignored. Module identifiers are lower-case everywhere except Booking, so a peer that lower-cased the lot is still understood.
• Booking and bookings are treated as the same module. The Bookings chapter gives “Module Identifier: Booking” — singular, and the only mixed-case identifier in OCPI — while implementations that assumed the lower-case plural exist. Getting this wrong means silently not discovering the module, which is worse than accepting both.

Use this when reading a peer’s version details; use == when the exact value matters.

pub fn is_supported(&self) -> bool

Whether this build of ocpi-kit has a wire model for this module.

pub fn exists_in(&self, version: &VersionNumber) -> bool

Whether the module exists in version.

Spec: 2.2.1 and 2.3.0 §version_information_endpoint_moduleid_enum; 2.1.1 §version_information_endpoint (which has neither hubclientinfo nor chargingprofiles).

Trait Implementations

impl Clone for ModuleId

fn clone(&self) -> ModuleId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModuleId

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ModuleId

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

Formats the value using the given formatter.

impl Eq for ModuleId

impl From<&str> for ModuleId

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for ModuleId

type Err = !

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ModuleId

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 ModuleId

Available on crate feature schema only.

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

The name of the generated JSON Schema.

fn json_schema(_g: &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.

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

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

impl Ord for ModuleId

fn cmp(&self, other: &Self) -> 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 ModuleId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ModuleId

fn partial_cmp(&self, other: &Self) -> 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 ModuleId

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Validate for ModuleId

fn validate_in(&self, v: &mut Validator)

Appends this value’s violations to v, relative to v’s current position.

fn validate(&self) -> Result<(), Violations>

Validates this value as the root of an object graph.