Enum CreditRegistrationState 

pub enum CreditRegistrationState {
    Pending,
    ReadyToSubmit,
    ResolvingEnrolment,
    CheckingEnrolment,
    NoUsableEnrolment,
    Submitting,
    SubmissionUncertain,
    AwaitingVerification,
    PartiallyRegistered,
    Registered,
    Duplicate,
    NotImproved,
    Misregistered,
    FailedRetryable,
    FailedPermanent,
    Blocked,
    Cancelled,
}

What the pipeline does next with a ledger row.

Variants

Pending

Waiting on a precondition: the completion or a linked student number. Which one is derived at read time, never stored.

ReadyToSubmit

ResolvingEnrolment

CheckingEnrolment

NoUsableEnrolment

Submitting

SubmissionUncertain

AwaitingVerification

PartiallyRegistered

Sisu holds the assessment item attainment, and verify keeps polling for the course unit attainment that makes the credit count.

Registered

Duplicate

NotImproved

Misregistered

FailedRetryable

FailedPermanent

Blocked

Cancelled

Implementations

impl CreditRegistrationState

pub const ALL: [Self; 17]

Every state, so a classification can be proven exhaustive at runtime too.

pub const SUCCESS_STATES: [Self; 3]

Self::is_success’s states, for binding as = ANY($n::credit_registration_state[]) in queries that would otherwise hand-retype the same set as a SQL literal. Order-independent; kept in is_success’s own order for readability.

pub const OTHER_SUCCESS_STATES: [Self; 2]

Self::SUCCESS_STATES minus Registered: the credit exists but we did not put it there.

pub const IN_FLIGHT_STATES: [Self; 4]

The states of a row whose submission may be in Sisu with its outcome not yet known: a request may be out, or its answer is still to be verified.

pub const HARD_FAILURE_STATES: [Self; 2]

The two states a “failed” count means across the admin reports: a permanent submit failure and a reversal the study registry made after the fact.

pub fn is_terminal(self) -> bool

States the pipeline never leaves on its own. terminal_at tracks membership, cleared on exit so an admin retry becomes visible to the stuck queries again.

pub fn is_failed_state(self) -> bool

Entry to one of these anchors the retry window in first_failed_at. Not the same question as whether a move carries an error code.

pub fn is_success(self) -> bool

Used for reporting and for the double-registration guard.

pub fn allowed_targets(self) -> &'static [Self]

The states the pipeline itself may move a row from self to, staying put excluded.

The one place the shape of the machine is written down: every edge here is one a phase, the precondition recompute or the grade-improvement materialiser actually takes, and transition refuses anything else. Admin-only edges live in ADMIN_ONLY_TARGETS instead, kept out of reach of a phase that could take one by mistake.

fn may_resend_after_sending(self, strictness: ResubmissionStrictness) -> bool

Whether a row that has been sent may be sent again from this state. The outcomes lead a possibly landed import back towards import only on Suotar’s notRegistered, so the pipeline states here mean nothing landed.

pub(super) fn pending_supersession_effect(self) -> PendingSupersessionEffect

What an attempt entering self does to the rows it was sent to replace; see mark_pending_superseded.

pub fn keeps_enrolment_check_schedule(self) -> bool

The states of the wait for an enrolment: no_usable_enrolment, and those a first check or a retried lookup passes through on its way there. Entering any other clears the check schedule.

pub(super) fn default_attempt_delay(self) -> TimeDelta

How long a row entering this state waits before the pipeline may claim it again, when the caller of transition names no time of its own. Zero leaves it claimable at once.

Only the states a claim query reads, or a precondition arm holds a row in, need a nonzero one: a phase that forgot to defer would otherwise spin on the row, since every claim orders by next_attempt_at. A caller with a real backoff to apply passes it and overrides this.

Trait Implementations

impl Clone for CreditRegistrationState

fn clone(&self) -> CreditRegistrationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for CreditRegistrationState

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for CreditRegistrationState

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

Formats the value using the given formatter.

impl<'r> Decode<'r, Postgres> for CreditRegistrationState

fn decode( value: PgValueRef<'r>, ) -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Decode a new value of this type using a raw value from the database.

impl<'de> Deserialize<'de> for CreditRegistrationState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'q, DB: Database> Encode<'q, DB> for CreditRegistrationState

where &'q str: Encode<'q, DB>,

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, BoxDynError>

Writes the value of self into buf without moving self.

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

impl Hash for CreditRegistrationState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CreditRegistrationState

fn eq(&self, other: &CreditRegistrationState) -> 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 PgHasArrayType for CreditRegistrationState

fn array_type_info() -> PgTypeInfo

fn array_compatible(ty: &PgTypeInfo) -> bool

impl Serialize for CreditRegistrationState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for CreditRegistrationState

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Type<Postgres> for CreditRegistrationState

fn type_info() -> PgTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for CreditRegistrationState

impl Eq for CreditRegistrationState

impl StructuralPartialEq for CreditRegistrationState