Struct ReceiptSummary 

pub struct ReceiptSummary {
    pub receipt_id: ReceiptId,
    pub status_code: String,
    pub severity: ReceiptSeverity,
    pub event_ids: Vec<EventId>,
    pub title: String,
    pub body: String,
}

A receipt as summarized for the narrator.

Fields

receipt_id: ReceiptId

The receipt.

status_code: String

Status code.

severity: ReceiptSeverity

Severity.

event_ids: Vec<EventId>

Events behind it.

title: String

The receipt’s own title, in the reader’s locale.

Why the narrator is shown the copy and not only the code

A status code says that something happened; it does not say what. A narrator given firm.field_set and nothing else can only write the sentence that is true of any such event — that a datum was noted — while the receipt rendered directly beneath the prose says which field took which value. The reader gets an acknowledgement that is vaguer than the block under it, from the same turn.

This does not widen what the narrator may claim. The receipt is already on screen, already passed the claim guard, and is already backed by the events it cites; letting the prose above it say the same thing is restating a claim the server has made, not making a new one.

body: String

The receipt’s own body, in the reader’s locale. See Self::title.

Implementations

impl ReceiptSummary

pub fn of(receipt: &OperationalReceipt, locale: &Locale) -> Self

Summarizes receipt for a reader of locale.

The copy is resolved here rather than carried as crate::locale::LocalizedText so that what the narrator reads is exactly the string the reader will see below it. Two renderings of one receipt in one turn is the failure this avoids.

Trait Implementations

impl Clone for ReceiptSummary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReceiptSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReceiptSummary

impl PartialEq for ReceiptSummary

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReceiptSummary

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 ReceiptSummary