Struct PartyRef 

pub struct PartyRef {
    pub country_code: CountryCode,
    pub party_id: PartyId,
}

The country_code + party_id pair that identifies one OCPI party.

This is the pair that appears in the OCPI-to-* and OCPI-from-* routing headers, in the URL of every client-owned object, and in the roles of a Credentials object. Because CiString compares case-insensitively, NL/TNM and nl/tnm are the same party.

use ocpi_kit::types::PartyRef;

let a: PartyRef = "NL/TNM".parse().unwrap();
let b = PartyRef::new("nl", "tnm").unwrap();
assert_eq!(a, b);
assert_eq!(a.to_string(), "NL/TNM");

Spec: 2.3.0 §transport_and_format_message_routing

Fields

country_code: CountryCode

ISO-3166 alpha-2 country code of the party.

party_id: PartyId

The party’s ID.

Implementations

impl PartyRef

pub fn new( country_code: impl Into<String>, party_id: impl Into<String>, ) -> Result<Self, InvalidString>

Creates a party reference.

Errors

Returns InvalidString if either part is not printable ASCII of the right length.

pub fn to_hub_party_id(&self) -> CiString<5>

The five-character concatenation used by Credentials.hub_party_id.

Spec: 2.3.0 §credentials_credentials_object — “The two-letter country code and three-character party ID are concatenated together in this field as one five-character string.”

pub fn from_hub_party_id(value: &CiString<5>) -> Result<Self, InvalidString>

Splits a five-character hub_party_id back into its country code and party ID.

Errors

Returns InvalidString if the value is not exactly five printable ASCII characters.

Trait Implementations

impl Clone for PartyRef

fn clone(&self) -> PartyRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartyRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartyRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PartyRef

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

Formats the value using the given formatter.

impl Eq for PartyRef

impl FromStr for PartyRef

type Err = InvalidPartyRef

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PartyRef

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 JsonSchema for PartyRef

Available on crate feature schema only.

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 Ord for PartyRef

fn cmp(&self, other: &PartyRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PartyRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PartyRef

fn partial_cmp(&self, other: &PartyRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PartyRef

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 PartyRef

impl Validate for PartyRef

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.