Struct CallbackUrls 

pub struct CallbackUrls { /* private fields */ }

Available on crate feature server only.

Builds the response_urls that reach the callbacks this crate’s router mounts.

The asynchronous halves of the Commands and Charging Profiles modules are the one place where OCPI hands the URL shape to the implementation:

No structure defined. This is open to the eMSP to define, the URL is provided to the Receiver by the Sender.

That freedom is easy to get wrong in a way that only shows up minutes later, when a Charge Point answers into a 404. So the Sender-side mounts on OcpiRouter use fixed shapes, and this type builds exactly those — pass the same base_url the router is published under and the two cannot drift apart.

use ocpi_kit::server::CallbackUrls;
use ocpi_kit::types::Url;

let urls = CallbackUrls::new(Url::new("https://msp.example.com/ocpi/emsp/2.3.0").unwrap());
assert_eq!(
    urls.command_result("RESERVE_NOW", "1234").as_str(),
    "https://msp.example.com/ocpi/emsp/2.3.0/commands/RESERVE_NOW/1234",
);
assert_eq!(
    urls.clear_profile_result("5678").as_str(),
    "https://msp.example.com/ocpi/emsp/2.3.0/chargingprofiles/result/clear/5678",
);

Implementations

impl CallbackUrls

pub const fn new(base_url: Url) -> Self

Callback URLs under base_url, which must be the URL this party’s router is published at.

pub const fn base(&self) -> &Url

The base URL these callbacks are built from.

pub fn command_result(&self, command: &str, unique_id: &str) -> Url

{base}/commands/{command}/{unique_id} — where a CommandResult is expected.

Put this in the response_url of a Command; it reaches CommandsSender::command_result with unique_id.

pub fn active_charging_profile_result(&self, unique_id: &str) -> Url

{base}/chargingprofiles/result/active/{unique_id} — for an ActiveChargingProfileResult.

pub fn charging_profile_result(&self, unique_id: &str) -> Url

{base}/chargingprofiles/result/set/{unique_id} — for a ChargingProfileResult.

pub fn clear_profile_result(&self, unique_id: &str) -> Url

{base}/chargingprofiles/result/clear/{unique_id} — for a ClearProfileResult.

Trait Implementations

impl Clone for CallbackUrls

fn clone(&self) -> CallbackUrls

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallbackUrls

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

Formats the value using the given formatter.

impl Eq for CallbackUrls

impl PartialEq for CallbackUrls

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CallbackUrls