Struct Tariff 

pub struct Tariff {

    pub country_code: CountryCode,
    pub party_id: PartyId,
    pub id: CiString<36>,
    pub currency: Currency,
    pub tariff_type: Option<TariffType>,
    pub tariff_alt_text: Vec<DisplayText>,
    pub tariff_alt_url: Option<Url>,
    pub min_price: Option<PriceLimit>,
    pub max_price: Option<PriceLimit>,
    pub preauthorize_amount: Option<Number>,
    pub elements: Vec<TariffElement>,
    pub tax_included: TaxIncluded,
    pub start_date_time: Option<DateTime>,
    pub end_date_time: Option<DateTime>,
    pub energy_mix: Option<EnergyMix>,
    pub last_updated: DateTime,
    pub extensions: Extensions,
}

Available on crate feature v2_3_0 only.

A tariff: one or more TariffElements that price a charging session.

When the list of Tariff Elements contains more than one Element that has a Price Component for a certain dimension, then the first Tariff Element with a Price Component for that dimension in the list with matching Tariff Restrictions will be used.

Spec: 2.3.0 §mod_tariffs_tariff_object

Fields

country_code: CountryCode

ISO-3166 alpha-2 country code of the CPO that owns this Tariff.

party_id: PartyId

ID of the CPO that ‘owns’ this Tariff.

id: CiString<36>

Uniquely identifies the tariff within the CPO’s platform.

currency: Currency

ISO-4217 code of the currency of this tariff.

tariff_type: Option<TariffType>

The type of the tariff. When omitted, this tariff is valid for all sessions.

tariff_alt_text: Vec<DisplayText>

Multi-language alternative tariff info texts.

When a Tariff contains both the tariff_alt_text and elements fields, the tariff_alt_text SHALL only contain additional tariff information in human-readable text, not the price information that is also available via the elements field.

tariff_alt_url: Option<Url>

URL to a web page explaining the tariff in human-readable form.

min_price: Option<PriceLimit>

A Charging Session with this tariff will cost at least this amount.

max_price: Option<PriceLimit>

A Charging Session with this tariff will cost at most this amount.

preauthorize_amount: Option<Number>

The amount a Payment Terminal Provider should preauthorize for a Session with this Tariff. New in OCPI 2.3.0, together with the Payments module.

elements: Vec<TariffElement>

The Tariff Elements. Cardinality +.

tax_included: TaxIncluded

Whether taxes are included in the amounts in this Tariff. New in OCPI 2.3.0.

start_date_time: Option<DateTime>

When this tariff becomes active, in UTC.

end_date_time: Option<DateTime>

When this tariff stops being valid, in UTC.

energy_mix: Option<EnergyMix>

Details on the energy supplied with this tariff.

last_updated: DateTime

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

extensions: Extensions

Undocumented JSON fields, preserved verbatim.

Implementations

impl Tariff

pub fn builder() -> TariffBuilder

Create an instance of Tariff using the builder syntax

impl Tariff

pub fn owner_party(&self) -> PartyRef

The CPO that owns this Tariff.

pub fn is_active_at(&self, instant: DateTime) -> bool

Whether this tariff is in its validity window at instant.

An absent start_date_time means “already active”; an absent end_date_time means “still active”.

pub fn is_free_of_charge(&self) -> bool

Whether this is the “Free of Charge” shape the spec prescribes.

To define a “Free of Charge” tariff in OCPI, a Tariff containing one Tariff Element with no restrictions containing one Price Component with type = FLAT and price = 0.00 has to be provided.

Trait Implementations

impl Clone for Tariff

fn clone(&self) -> Tariff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tariff

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tariff

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Downgrade<Tariff> for Tariff

Available on crate feature convert only.

fn downgrade(self) -> Converted<Tariff>

A 2.2.1 Tariff’s prices are excluding VAT by definition, so a 2.3.0 Tariff that says tax_included: YES cannot be represented: the same numbers would mean a different amount of money. That is recorded as a loss rather than silently reinterpreted.

impl JsonSchema for Tariff

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 Tariff

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tariff

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Stored for Tariff

Available on crate feature testkit only.

fn key(&self) -> String

The id this object is keyed by, compared case-insensitively.

fn last_updated(&self) -> DateTime

The last_updated the pagination filters on.

impl StructuralPartialEq for Tariff

impl Upgrade<Tariff> for Tariff

Available on crate feature convert only.

fn upgrade(self) -> Converted<Tariff>

tax_included becomes NO.

This is not a guess: a 2.2.1 PriceComponent.price is defined as “Price per unit (excl. VAT) for this dimension”, so every amount in a 2.2.1 Tariff is pre-tax by construction, which is exactly what NO means.

preauthorize_amount starts absent — 2.2.1 has no Payments module to preauthorize for.

impl Validate for Tariff

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.