Struct Credentials 

pub struct Credentials {
    pub token: OcpiString<64>,
    pub url: Url,
    pub hub_party_id: Option<CiString<5>>,
    pub roles: Vec<CredentialsRole>,
    pub extensions: Extensions,
}

Available on crate feature v2_3_0 only.

The credentials one platform gives another.

Spec: 2.3.0 §credentials_credentials_object

Fields

token: OcpiString<64>

The credentials token for the other party to authenticate in your system.

It should only contain printable non-whitespace ASCII characters, that is, characters with Unicode code points from the range of U+0021 up to and including U+007E.

This is the token in cleartext — the value that goes, Base64-encoded, into the peer’s Authorization header. CredentialsToken is the type to hold it in once it leaves this object: it redacts itself in Debug, compares in constant time and is zeroised on drop.

url: Url

The URL to your API versions endpoint.

hub_party_id: Option<CiString<5>>

The Hub party of this platform, as a five-character <country><party> string.

A Platform that supports Hub functionality with the Message routing headers SHALL give the country code and party ID of the Hub in the hub_party_id field.

New in OCPI 2.3.0. Use PartyRef::from_hub_party_id to split it.

roles: Vec<CredentialsRole>

The roles this platform provides. Cardinality +.

NOTE: In OCPI 2.3.0, unlike in OCPI 2.2 or 2.2.1, Roaming Hubs’ platforms are expected to include the parties that are reachable through the Roaming Hub in the list in roles.

extensions: Extensions

Undocumented JSON fields, preserved verbatim.

Implementations

impl Credentials

pub fn builder() -> CredentialsBuilder

Create an instance of Credentials using the builder syntax

impl Credentials

pub fn parties(&self) -> impl Iterator<Item = PartyRef> + '_

Every party this platform speaks for.

pub fn hosts(&self, party: &PartyRef) -> bool

Whether this platform hosts the given party.

pub fn hub_party(&self) -> Option<PartyRef>

The hub this platform routes through, if it declared one.

pub fn is_routing_platform(&self) -> bool

Whether this platform advertises itself as a routing platform.

A hub is recognised by the presence of hub_party_id, not by a role: OCPI 2.3.0 removed 2.2.1’s HUB role value.

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Downgrade<Credentials> for Credentials

Available on crate feature convert only.

fn downgrade(self) -> Converted<Credentials>

A 2.3.0 hub_party_id becomes a 2.2.1 HUB role.

The 2.2.1 role needs business_details, which 2.3.0 does not carry for the hub party itself; the first role’s details are reused and the substitution is reported.

impl JsonSchema for Credentials

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Credentials

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Credentials

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Credentials

impl Upgrade<Credentials> for Credentials

Available on crate feature convert only.

fn upgrade(self) -> Converted<Credentials>

A 2.2.1 HUB role becomes 2.3.0’s hub_party_id, and the role entry is dropped: that is exactly where OCPI 2.3.0 moved the information.

A Platform that supports Hub functionality with the Message routing headers SHALL give the country code and party ID of the Hub in the hub_party_id field.

impl Validate for Credentials

fn validate_in(&self, v: &mut Validator)

Appends this value’s violations to v, relative to v’s current position.

fn validate(&self) -> Result<(), Violations>

Validates this value as the root of an object graph.