Struct RoutingHeaders 

pub struct RoutingHeaders {
    pub to: Option<PartyRef>,
    pub from: PartyRef,
}

Available on crate feature transport only.

The OCPI-to-* and OCPI-from-* headers of one message.

When implementing OCPI these four headers SHALL be implemented for any request/response to/from a Functional Module. This does not mean they have to be present in all request.

to is None for an Open Routing Request, where the hub decides the destination from the content.

Spec: 2.3.0 §transport_and_format_message_routing

Fields

to: Option<PartyRef>

The party this message is to be sent to, absent for an Open Routing Request.

from: PartyRef

The party this message is sent from.

Implementations

impl RoutingHeaders

pub fn new(from: PartyRef, to: PartyRef) -> Self

Headers addressed from from to to.

pub fn open(from: PartyRef) -> Self

Headers with no to, for an Open Routing Request.

For an Open Routing Request, the TO headers in the request from the requesting party to the Hub MUST be omitted.

pub fn response_from(&self, responder: PartyRef) -> Self

The headers of the response to this request, which swap to and from.

For an Open Routing Request the responder is the receiving party, which the requester did not know; pass it as responder.

pub fn from_headers(headers: &HeaderMap) -> Option<Self>

Reads the routing headers from a header map.

Returns None when the from pair is absent, which is either a spec violation or a configuration module — see RoutingHeaders::applies_to.

pub fn write_to(&self, headers: &mut HeaderMap)

Writes the routing headers into a header map.

pub fn applies_to(module: &ModuleId) -> bool

Whether these headers belong on a request to module.

The requests/responses to/from Configuration Modules: Credentials, Versions and Hub Client Info are not to be routed, and are for Platform-to-Platform or Platform-to-Hub communication. Thus routing headers SHALL NOT be used with these modules.

Trait Implementations

impl Clone for RoutingHeaders

fn clone(&self) -> RoutingHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoutingHeaders

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

Formats the value using the given formatter.

impl Display for RoutingHeaders

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

Formats the value using the given formatter.

impl Eq for RoutingHeaders

impl PartialEq for RoutingHeaders

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoutingHeaders