Enum VersionNumber 

#[non_exhaustive]
pub enum VersionNumber {
    V2_0,
    V2_1,
    V2_1_1,
    V2_2,
    V2_2_1,
    V2_3_0,
    Custom(String),
}

A version of the OCPI protocol, as it appears in /versions and in version details.

Listed as an OpenEnum so that discovery against a peer that speaks a version this crate has never heard of — a future 3.0, or a version the peer invented — lists it and moves on instead of failing. VersionNumber::is_supported says which ones this build can actually talk.

Spec: 2.3.0 §version_information_endpoint_versionnumber_enum

This is an OCPI OpenEnum: a value this version of the specification does not define is a legitimate extension, and Validate does not report it.

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.

V2_0

OCPI version 2.0. Not modelled by this crate; recognised so discovery can skip it.

Wire value: 2.0

V2_1

OCPI version 2.1. Deprecated by the spec: “do not use, use 2.1.1 instead”.

Wire value: 2.1

V2_1_1

OCPI version 2.1.1.

Wire value: 2.1.1

V2_2

OCPI version 2.2. Deprecated by the spec: “do not use, use 2.2.1 instead”.

Wire value: 2.2

V2_2_1

OCPI version 2.2.1. Still the most widely deployed version.

Wire value: 2.2.1

V2_3_0

OCPI version 2.3.0. The canonical model of this crate.

Wire value: 2.3.0

Custom(String)

A value this version of the specification does not define, preserved verbatim.

The variant is named Custom rather than Other because several OCPI OpenEnums have a defined value that is literally OTHER.

Implementations

impl VersionNumber

pub const ALL_KNOWN: &'static [Self]

Every value this version of the specification defines, in declaration order.

pub const ALL_KNOWN_WIRE: &'static [&'static str]

Every wire value this version of the specification defines.

pub fn as_str(&self) -> &str

The value as it appears on the wire.

pub const fn is_known(&self) -> bool

Whether this is a value the specification defines.

pub fn from_str_ignore_case(s: &str) -> Self

Parses a wire value, ignoring ASCII case for the known values.

For peers that get the case wrong; FromStr is strict.

impl VersionNumber

pub fn is_supported(&self) -> bool

Whether this build of ocpi-kit has a wire model for this version.

Depends on the enabled cargo features.

pub const fn is_deprecated(&self) -> bool

Whether the specification marks this version as deprecated.

Spec: 2.3.0 §version_information_endpoint_versionnumber_enum

pub fn supported() -> Vec<Self>

Every version this build can talk, newest first.

This is the preference order used when negotiating with a peer.

pub const fn release_rank(&self) -> u8

Where this version sits in the release order, oldest first.

A version this crate does not know ranks last. This is deliberately not the Ord impl, which sorts by wire value so that VersionNumber behaves predictably as a map key — and note that sorting by wire value is wrong for versions, since "2.10" < "2.2" lexically. Use VersionNumber::cmp_by_release to order them.

pub fn cmp_by_release(&self, other: &Self) -> Ordering

Orders two versions by release, oldest first; unknown versions sort last, by their text.

use ocpi_kit::VersionNumber;
let mut vs = vec![VersionNumber::V2_3_0, VersionNumber::V2_1_1, VersionNumber::V2_2_1];
vs.sort_by(VersionNumber::cmp_by_release);
assert_eq!(vs.first(), Some(&VersionNumber::V2_1_1));

pub fn has_routing_headers(&self) -> bool

Whether the version uses the OCPI-to-*/OCPI-from-* message routing headers.

Routing headers were introduced in OCPI 2.2; 2.1.1 and older have no such thing.

Spec: 2.3.0 §transport_and_format_message_routing

pub fn has_credentials_roles(&self) -> bool

Whether the version splits Credentials into a list of roles.

OCPI 2.1.1 puts party_id, country_code and business_details directly on the credentials object; 2.2 and later moved them into CredentialsRole entries.

Trait Implementations

impl Clone for VersionNumber

fn clone(&self) -> VersionNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionNumber

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionNumber

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for VersionNumber

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

Formats the value using the given formatter.

impl Eq for VersionNumber

impl From<&str> for VersionNumber

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for VersionNumber

type Err = !

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 VersionNumber

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 VersionNumber

Available on crate feature schema only.

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

The name of the generated JSON Schema.

fn json_schema(_g: &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.

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

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

impl Ord for VersionNumber

fn cmp(&self, other: &Self) -> 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 VersionNumber

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VersionNumber

fn partial_cmp(&self, other: &Self) -> 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 VersionNumber

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Validate for VersionNumber

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.