Struct ServerConfig 

#[non_exhaustive]
pub struct ServerConfig {
    pub quirks: Quirks,
    pub max_page_limit: u64,
    pub receiver_path_prefix: Option<String>,
}

Available on crate feature server only.

How the server behaves.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

quirks: Quirks

The interoperability profile for incoming requests, chiefly whether an unencoded Authorization token is accepted.

max_page_limit: u64

The largest page a list endpoint will return, which is what X-Limit advertises.

X-Limit: The maximum number of objects that the server can return.

receiver_path_prefix: Option<String>

A path segment inserted before every Receiver interface, e.g. receiver.

Why this exists

The Locations Sender and Receiver interfaces have structurally identical URLs:

Sender:   {locations}/{location_id}/{evse_uid}/{connector_id}
Receiver: {locations}/{country_code}/{party_id}/{location_id}

Three path segments either way, so no router can tell them apart. The specification does not have this problem because the two are different endpoints with independently chosen URLs — in practice /ocpi/cpo/2.3.0/locations and /ocpi/emsp/2.3.0/locations — and “The exact URL can be found by fetching the endpoint information from the API info endpoint”.

A platform that is both CPO and eMSP therefore has two choices, and this field picks between them:

• Some("receiver") (the default) — one router, one /versions, and the Receiver interfaces published one segment deeper. The generated version details say so.
• None — the conventional split, with one OcpiRouter per role nested under its own base URL; set it with one_router_per_role. Mounting both interfaces of an ambiguously-shaped module on one router with no prefix is a configuration error and panics at start-up with an explanation.

Charging Profiles ({session_id} on both sides) and Payments (terminals/{terminal_id} on both sides) have the same problem as Locations.

Spec: 2.3.0 §transport_and_format_interface_endpoints

Implementations

impl ServerConfig

pub fn with_quirks(self, quirks: Quirks) -> Self

Sets the interoperability profile for incoming requests.

pub const fn with_max_page_limit(self, limit: u64) -> Self

Sets the largest page a list endpoint will return, which is what X-Limit advertises and what the Page extractor clamps an incoming limit to.

pub fn with_receiver_path_prefix(self, prefix: impl Into<String>) -> Self

Publishes the Receiver interfaces under prefix instead of the default receiver.

pub fn one_router_per_role(self) -> Self

Publishes the Receiver interfaces at their bare paths, for a deployment that runs one router per role.

This is the conventional OCPI split — /ocpi/cpo/2.3.0/locations and /ocpi/emsp/2.3.0/locations are different endpoints with independently chosen URLs — and it is the right choice when each role has its own base URL. It is not a choice a platform serving both roles from one router can make: see receiver_path_prefix for why, and expect a panic at start-up if you try.

Trait Implementations

impl Clone for ServerConfig

fn clone(&self) -> ServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerConfig

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

Formats the value using the given formatter.

impl Default for ServerConfig

fn default() -> Self

Returns the “default value” for a type.