Struct ClaimState 

pub struct ClaimState {
    pub reference: Option<String>,
    pub attachment: Option<AttachmentId>,
    pub proposal: Option<Proposal>,
    pub recorded: Vec<RecordedField>,
    pub abandoned_from: Option<AttachmentId>,
    pub status: ClaimStatus,
}

The persisted claim case.

Fields

reference: Option<String>

A reference the user types by hand.

It exists to be outside every proposal: editing it while a review is open must not change what the review card is about, which is what makes “the payload hash covers the proposal rather than the whole state” a testable sentence rather than a slogan.

attachment: Option<AttachmentId>

The document that arrived, once it has.

proposal: Option<Proposal>

Values read from the document and awaiting review.

recorded: Vec<RecordedField>

Values that survived a review, with their provenance.

abandoned_from: Option<AttachmentId>

The document whose reading the user threw away, when they did.

status: ClaimStatus

Lifecycle status.

Implementations

impl ClaimState

pub fn open_obligations(&self) -> Vec<ClaimObligation>

The obligations open in this state, in a stable order.

While a review is open there is one obligation per proposed field and one per missing required field. Both are parameterized, so three proposed values are three distinct obligations rather than one checkpoint that flickers as the user works through them.

pub fn recorded_value(&self, field: ClaimField) -> Option<&str>

The recorded value of a field, when the review put one there.

pub const fn is_awaiting_review(&self) -> bool

Returns true when a review is open.

Trait Implementations

impl Clone for ClaimState

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 ClaimState

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

Formats the value using the given formatter.

impl Default for ClaimState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClaimState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClaimState

impl PartialEq for ClaimState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ClaimState

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 ClaimState