Struct Session 

pub struct Session {

    pub country_code: CountryCode,
    pub party_id: PartyId,
    pub id: CiString<36>,
    pub start_date_time: DateTime,
    pub end_date_time: Option<DateTime>,
    pub kwh: Number,
    pub cdr_token: CdrToken,
    pub auth_method: AuthMethod,
    pub authorization_reference: Option<CiString<36>>,
    pub location_id: CiString<36>,
    pub evse_uid: CiString<36>,
    pub connector_id: CiString<36>,
    pub meter_id: Option<OcpiString<255>>,
    pub currency: Currency,
    pub charging_periods: Vec<ChargingPeriod>,
    pub total_cost: Option<Price>,
    pub status: SessionStatus,
    pub last_updated: DateTime,
    pub extensions: Extensions,
}

Available on crate feature v2_2_1 only.

One charging session, as it stands right now, in OCPI 2.2.1.

Spec: 2.2.1 §mod_sessions_session_object

Fields

country_code: CountryCode

ISO-3166 alpha-2 country code of the CPO that ‘owns’ this Session.

party_id: PartyId

ID of the CPO that ‘owns’ this Session.

id: CiString<36>

The unique id that identifies the charging session in the CPO platform.

start_date_time: DateTime

When the session became ACTIVE in the Charge Point.

end_date_time: Option<DateTime>

When the session was completed.

kwh: Number

How many kWh were charged.

cdr_token: CdrToken

Token used to start this charging session.

auth_method: AuthMethod

Method used for authentication.

authorization_reference: Option<CiString<36>>

Reference to the authorization given by the eMSP.

location_id: CiString<36>

Location.id on which the charging session is or was happening.

evse_uid: CiString<36>

EVSE.uid on which the charging session is or was happening. May be #NA.

connector_id: CiString<36>

Connector.id where the charging session is or was happening. May be #NA.

meter_id: Option<OcpiString<255>>

Optional identification of the kWh meter.

currency: Currency

ISO 4217 code of the currency used for this session.

charging_periods: Vec<ChargingPeriod>

Charging Periods that can be used to calculate and verify the total cost.

total_cost: Option<Price>

The total cost of the session.

status: SessionStatus

The status of the session.

last_updated: DateTime

Timestamp when this Session was last updated (or created).

extensions: Extensions

Undocumented JSON fields, preserved verbatim.

Implementations

impl Session

pub fn builder() -> SessionBuilder

Create an instance of Session using the builder syntax

impl Session

pub fn owner_party(&self) -> PartyRef

The CPO that owns this Session.

pub fn has_assigned_evse(&self) -> bool

Whether an EVSE and connector have been assigned yet.

pub fn dimension_total(&self, dimension: CdrDimensionType) -> Number

The total volume of one dimension across every charging period.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Session

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Downgrade<Session> for Session

Available on crate feature convert only.

fn downgrade(self) -> Converted<Session>

Converts to the older version.

impl JsonSchema for Session

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 Session

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Session

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 Session

impl Upgrade<Session> for Session

Available on crate feature convert only.

fn upgrade(self) -> Converted<Session>

Converts to the newer version.

impl Validate for Session

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.