Enum RoutingScenario 

#[non_exhaustive]
pub enum RoutingScenario {
    Direct,
    BroadcastPush {
        hub: PartyRef,
    },
    OpenRoutingRequest,
    GetAllViaHub {
        hub: PartyRef,
    },
}

Available on crate feature transport only.

One of the five routing arrangements the specification tabulates.

Each variant knows how to fill the headers for both the request and the response, in both directions across a hub. This is the whole of §transport_and_format_message_routing’s “Overview of required/optional routing headers for different scenarios” in one type.

use ocpi_kit::transport::RoutingScenario;
use ocpi_kit::types::PartyRef;

let cpo = PartyRef::new("NL", "TNM").unwrap();
let msp = PartyRef::new("DE", "ABC").unwrap();
let hub = PartyRef::new("NL", "HUB").unwrap();

// A broadcast push addresses the hub, not the eventual receivers.
let scenario = RoutingScenario::BroadcastPush { hub: hub.clone() };
let request = scenario.request_headers(&cpo, None);
assert_eq!(request.to, Some(hub));
assert_eq!(request.from, cpo);

Spec: 2.3.0 §transport_and_format_message_routing

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.

Direct

Requesting platform to receiving platform, directly or through a hub that just relays.

	TO	FROM
request	receiving party	requesting party
response	requesting party	receiving party

BroadcastPush

A push to every connected party with the opposite role, fanned out by the hub.

	TO	FROM
requester → hub	hub	requesting party
hub → requester	requesting party	hub
hub → receiver	receiving party	hub
receiver → hub	hub	receiving party

GET SHALL NOT be used in combination with Broadcast Push.

Fields

hub: PartyRef

The hub that fans the message out.

OpenRoutingRequest

The requester does not know the destination; the hub decides from the content.

	TO	FROM
requester → hub	omitted	requesting party
hub → receiver	receiving party	requesting party
receiver → hub	requesting party	receiving party
hub → requester	requesting party	receiving party

Open Routing Requests are possible for GET (Not GET ALL), POST, PUT, PATCH and DELETE.

GetAllViaHub

A GET on a Sender interface implemented by the hub, merging several parties’ objects.

	TO	FROM
requester → hub	hub	requesting party
hub → requester	requesting party	hub

Fields

hub: PartyRef

The hub that merges the objects.

Implementations

impl RoutingScenario

pub fn request_headers( &self, requester: &PartyRef, receiver: Option<&PartyRef>, ) -> RoutingHeaders

The headers of the request the requesting party sends.

receiver is the destination party; it is ignored by the scenarios that address the hub or omit the to headers entirely, and may be None there.

pub fn response_headers( &self, requester: &PartyRef, receiver: Option<&PartyRef>, ) -> RoutingHeaders

The headers of the response the requesting party will receive.

receiver is the party that actually answered, which the hub knows even when the requester did not.

pub fn forwarded_request_headers( &self, requester: &PartyRef, receiver: &PartyRef, ) -> Option<RoutingHeaders>

The headers the hub puts on the request it forwards to the receiving party.

Returns None for GetAllViaHub, where the hub answers from its own merged view and forwards nothing verbatim.

pub const fn allows_get(&self) -> bool

Whether a GET may use this scenario.

GET SHALL NOT be used in combination with Broadcast Push. If the requesting party wants to GET information of which it does not know the receiving party, an Open Routing Request MUST be used.

pub const fn allows_write(&self) -> bool

Whether a write (POST, PUT, PATCH, DELETE) may use this scenario.

A GET All is by definition a read.

Trait Implementations

impl Clone for RoutingScenario

fn clone(&self) -> RoutingScenario

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoutingScenario

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

Formats the value using the given formatter.

impl Eq for RoutingScenario

impl PartialEq for RoutingScenario

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoutingScenario