Enum SessionStatus 

#[non_exhaustive]
pub enum SessionStatus {
    Active,
    Completed,
    Invalid,
    Pending,
    Custom(String),
}

Available on crate feature v2_1_1 only.

The state of a session, in OCPI 2.1.1.

RESERVATION arrived in OCPI 2.2, with the reservation pricing that needed it.

Spec: 2.1.1 §mod_sessions_sessionstatus_enum

The specification declares this enum closed. This crate still decodes an unrecognised value into Custom rather than failing the whole object, and Validate reports 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.

Active

The session is accepted and active.

Wire value: ACTIVE

Completed

The session has finished successfully.

Wire value: COMPLETED

Invalid

The session is declared invalid and will not be billed.

Wire value: INVALID

Pending

The session is pending; it has not yet started.

Wire value: PENDING

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 SessionStatus

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 SessionStatus

pub fn is_terminal(&self) -> bool

Whether the session can still change.

Trait Implementations

impl Clone for SessionStatus

fn clone(&self) -> SessionStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionStatus

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

Deserialize this value from the given Serde deserializer.

impl Display for SessionStatus

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

Formats the value using the given formatter.

impl Eq for SessionStatus

impl From<&str> for SessionStatus

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for SessionStatus

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 SessionStatus

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 SessionStatus

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 SessionStatus

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 SessionStatus

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SessionStatus

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 SessionStatus

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

Serialize this value into the given Serde serializer.

impl Validate for SessionStatus

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.