Struct RequestIds 

pub struct RequestIds {
    pub request_id: String,
    pub correlation_id: String,
}

Available on crate feature transport only.

The pair of IDs every OCPI request and response carries.

For debugging issues, OCPI implementations are required to include unique IDs via HTTP headers in every request/response.

The distinction matters at a hub:

When a Hub forwards a request to a party, the request to this party SHALL contain a new unique value in the X-Request-ID HTTP header, not a copy … the request SHALL contain the same X-Correlation-ID HTTP header.

RequestIds::forwarded does exactly that, so a hub cannot get it backwards.

use ocpi_kit::transport::RequestIds;

let incoming = RequestIds::generate();
let forwarded = incoming.forwarded();
assert_ne!(incoming.request_id, forwarded.request_id);
assert_eq!(incoming.correlation_id, forwarded.correlation_id);

Spec: 2.3.0 §transport_and_format_unique_messageg_ids

Fields

request_id: String

Unique per request hop.

correlation_id: String

Unique per logical exchange, preserved across hub hops.

Implementations

impl RequestIds

pub fn generate() -> Self

A fresh pair of UUIDs.

It is advised to used GUID/UUID as values for X-Request-ID and X-Correlation-ID.

pub fn forwarded(&self) -> Self

The IDs a hub must use when forwarding this request: a new request ID, the same correlation ID.

pub fn from_headers_or_generate(headers: &HeaderMap) -> Self

Reads the pair from a header map, generating whichever half is missing.

A missing ID is a spec violation on the peer’s side, but refusing the request over it would be worse than carrying on with a generated one; the server echoes what it used.

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

Reads the pair from a header map, or None if either is absent.

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

Writes both headers into headers, replacing any existing values.

Trait Implementations

impl Clone for RequestIds

fn clone(&self) -> RequestIds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestIds

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

Formats the value using the given formatter.

impl Display for RequestIds

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

Formats the value using the given formatter.

impl Eq for RequestIds

impl Hash for RequestIds

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 PartialEq for RequestIds

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RequestIds