Skip to main content

TransactionEventRequest

Struct TransactionEventRequest 

Source
pub struct TransactionEventRequest {
Show 16 fields pub event_type: TransactionEventEnum, pub timestamp: DateTime, pub trigger_reason: TriggerReason, pub seq_no: i32, pub transaction_info: Transaction, pub cost_details: Option<CostDetails>, pub meter_value: Option<Vec<MeterValue>>, pub offline: Option<bool>, pub number_of_phases_used: Option<i32>, pub cable_max_current: Option<i32>, pub reservation_id: Option<i32>, pub preconditioning_status: Option<PreconditioningStatus>, pub evse_sleep: Option<bool>, pub evse: Option<EVSE>, pub id_token: Option<IdToken>, pub custom_data: Option<CustomData>,
}
Expand description

Spec: OCPP 2.1 · E — Transactions · Charging Station → CSMS · CALL.

Fields§

§event_type: TransactionEventEnum

The eventType member.

§timestamp: DateTime

The date and time at which this transaction event occurred.

§trigger_reason: TriggerReason

The triggerReason member.

§seq_no: i32

Incremental sequence number, helps with determining if all messages of a transaction have been received.

§transaction_info: Transaction

The transactionInfo member.

§cost_details: Option<CostDetails>

The costDetails member.

§meter_value: Option<Vec<MeterValue>>

The meterValue member.

§offline: Option<bool>

Indication that this transaction event happened when the Charging Station was offline. Default = false, meaning: the event occurred when the Charging Station was online. Schema default: false.

§number_of_phases_used: Option<i32>

If the Charging Station is able to report the number of phases used, then it SHALL provide it. When omitted the CSMS may be able to determine the number of phases used as follows: + 1: The numberPhases in the currently used ChargingSchedule. + 2: The number of phases provided via device management.

§cable_max_current: Option<i32>

The maximum current of the connected cable in Ampere (A).

§reservation_id: Option<i32>

This contains the Id of the reservation that terminates as a result of this transaction.

§preconditioning_status: Option<PreconditioningStatus>

The preconditioningStatus member.

§evse_sleep: Option<bool>

(2.1) True when EVSE electronics are in sleep mode for this transaction. Default value (when absent) is false.

§evse: Option<EVSE>

The evse member.

§id_token: Option<IdToken>

The idToken member.

§custom_data: Option<CustomData>

The customData member.

Implementations§

Source§

impl TransactionEventRequest

Source

pub fn new( event_type: TransactionEventEnum, timestamp: impl Into<DateTime>, trigger_reason: TriggerReason, seq_no: i32, transaction_info: Transaction, ) -> Self

Creates a TransactionEventRequest from its required fields.

Source

pub fn with_cost_details(self, value: CostDetails) -> Self

Sets the optional costDetails field.

Source

pub fn with_meter_value(self, value: Vec<MeterValue>) -> Self

Sets the optional meterValue field.

Source

pub fn with_offline(self, value: bool) -> Self

Sets the optional offline field.

Source

pub fn with_number_of_phases_used(self, value: i32) -> Self

Sets the optional numberOfPhasesUsed field.

Source

pub fn with_cable_max_current(self, value: i32) -> Self

Sets the optional cableMaxCurrent field.

Source

pub fn with_reservation_id(self, value: i32) -> Self

Sets the optional reservationId field.

Source

pub fn with_preconditioning_status(self, value: PreconditioningStatus) -> Self

Sets the optional preconditioningStatus field.

Source

pub fn with_evse_sleep(self, value: bool) -> Self

Sets the optional evseSleep field.

Source

pub fn with_evse(self, value: EVSE) -> Self

Sets the optional evse field.

Source

pub fn with_id_token(self, value: IdToken) -> Self

Sets the optional idToken field.

Source

pub fn with_custom_data(self, value: CustomData) -> Self

Sets the optional customData field.

Trait Implementations§

Source§

impl Clone for TransactionEventRequest

Source§

fn clone(&self) -> TransactionEventRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Confirmed for TransactionEventRequest

Source§

impl Debug for TransactionEventRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for TransactionEventRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TransactionEventRequest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Request for TransactionEventRequest

Source§

const ACTION: Action = Action::TransactionEvent

The action this payload belongs to.
Source§

const KIND: MessageKind = MessageKind::Call

CALL or SEND.
Source§

const ORIGIN: Origin = Origin::ChargingStation

Which peer originates this request.
Source§

type Action = Action

This version’s action enum.
Source§

type Response = TransactionEventResponse

The matching response payload, or NoResponse for a SEND.
Source§

impl Sealed for TransactionEventRequest

Source§

impl Serialize for TransactionEventRequest

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TransactionEventRequest

Source§

impl Validate for TransactionEventRequest

Source§

fn validate_at(&self, path: &mut ValidationPath, out: &mut Violations)

Appends this value’s violations to out, relative to path.
Source§

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

Validates this value from the payload root.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.