Enum StudentFacingCreditRegistrationStatus 

pub enum StudentFacingCreditRegistrationStatus {
    WaitingForCompletion,
    NeedsStudentNumber,
    LookingForEnrolment,
    NeedsEnrolment,
    WaitingForCourseSetup,
    Sending,
    WaitingForSisu,
    Registered,
    Failed,
    NotRegistering,
}

The stage a student sees.

Variants

WaitingForCompletion

NeedsStudentNumber

LookingForEnrolment

We are still working out which enrolment to register against. Not Self::NeedsEnrolment, which is the answer that there is none.

NeedsEnrolment

WaitingForCourseSetup

Held until staff fix the course’s registration settings, with no known end: unlike Self::LookingForEnrolment, not a short wait.

Sending

An enrolment is settled and the attainment is on its way to the study registry.

WaitingForSisu

Registered

Failed

NotRegistering

Nothing is happening and nothing will, until the student changes something.

Implementations

impl StudentFacingCreditRegistrationStatus

pub fn of( state: CreditRegistrationState, preconditions: PendingPreconditions, enrolment_resolved: bool, ) -> Self

preconditions is only read for pending, whose whole point is that the ledger does not record which of them the row is waiting on. Pass PendingPreconditions::ALL_MET only where the row is known not to be pending.

enrolment_resolved is whether the row has settled on an enrolment, which only failed_retryable reads: that state does not record which half of the work failed, and a retry while we are still looking for an enrolment is not a retry of the sending.

pub fn is_moving(self) -> bool

Whether the pipeline still moves this row on its own; the status page polls while it does.

Trait Implementations

impl Clone for StudentFacingCreditRegistrationStatus

fn clone(&self) -> StudentFacingCreditRegistrationStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for StudentFacingCreditRegistrationStatus

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

impl Debug for StudentFacingCreditRegistrationStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StudentFacingCreditRegistrationStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for StudentFacingCreditRegistrationStatus

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 StudentFacingCreditRegistrationStatus

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

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 StudentFacingCreditRegistrationStatus

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 Copy for StudentFacingCreditRegistrationStatus

impl Eq for StudentFacingCreditRegistrationStatus

impl StructuralPartialEq for StudentFacingCreditRegistrationStatus