Struct TransactionInfo 

#[non_exhaustive]
pub struct TransactionInfo {
    pub value: Option<f32>,
    pub currency: String,
    pub transaction_id: String,
    pub tax: Option<f32>,
    pub cost: Option<f32>,
    pub discount_value: Option<f32>,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

A transaction represents the entire purchase transaction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: Option<f32>

Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.

currency: String

Required. Currency code. Use three-character ISO-4217 code.

transaction_id: String

The transaction ID with a length limit of 128 characters.

tax: Option<f32>

All the taxes associated with the transaction.

cost: Option<f32>

All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that:

• Profit = value - tax - cost

discount_value: Option<f32>

The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value

For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value

This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value:

• Profit = value - tax - cost

Implementations

impl TransactionInfo

pub fn new() -> Self

pub fn set_value<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of value.

Example

let x = TransactionInfo::new().set_value(42.0);

pub fn set_or_clear_value<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of value.

Example

let x = TransactionInfo::new().set_or_clear_value(Some(42.0));
let x = TransactionInfo::new().set_or_clear_value(None::<f32>);

pub fn set_currency<T: Into<String>>(self, v: T) -> Self

Sets the value of currency.

Example

let x = TransactionInfo::new().set_currency("example");

pub fn set_transaction_id<T: Into<String>>(self, v: T) -> Self

Sets the value of transaction_id.

Example

let x = TransactionInfo::new().set_transaction_id("example");

pub fn set_tax<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of tax.

Example

let x = TransactionInfo::new().set_tax(42.0);

pub fn set_or_clear_tax<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of tax.

Example

let x = TransactionInfo::new().set_or_clear_tax(Some(42.0));
let x = TransactionInfo::new().set_or_clear_tax(None::<f32>);

pub fn set_cost<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of cost.

Example

let x = TransactionInfo::new().set_cost(42.0);

pub fn set_or_clear_cost<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of cost.

Example

let x = TransactionInfo::new().set_or_clear_cost(Some(42.0));
let x = TransactionInfo::new().set_or_clear_cost(None::<f32>);

pub fn set_discount_value<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of discount_value.

Example

let x = TransactionInfo::new().set_discount_value(42.0);

pub fn set_or_clear_discount_value<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of discount_value.

Example

let x = TransactionInfo::new().set_or_clear_discount_value(Some(42.0));
let x = TransactionInfo::new().set_or_clear_discount_value(None::<f32>);

Trait Implementations

impl Clone for TransactionInfo

fn clone(&self) -> TransactionInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionInfo

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

Formats the value using the given formatter.

impl Default for TransactionInfo

fn default() -> TransactionInfo

Returns the “default value” for a type.

impl Message for TransactionInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TransactionInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransactionInfo