Enum CreditRegistrationPhase 

pub enum CreditRegistrationPhase {
    Materialize,
    Preconditions,
    ResolveEnrolments,
    Import,
    Verify,
    LegacyMirror,
    StudentNotifications,
    EnrolmentDiscovery,
    LinkEmails,
    ConfigValidation,
    RetentionSweep,
    LedgerSnapshot,
}

A pipeline phase. CreditRegistrationPhase::as_str is canonical: it is credit_registration_phase_state.phase, the tick endpoint’s ?phase= and the audit log’s target_phase.

Variants

Materialize

Preconditions

ResolveEnrolments

Import

Verify

LegacyMirror

StudentNotifications

EnrolmentDiscovery

LinkEmails

ConfigValidation

RetentionSweep

LedgerSnapshot

Implementations

impl CreditRegistrationPhase

pub const ALL: [Self; 12]

Every phase, in pipeline order.

pub fn spec(self) -> &'static PhaseSpec

Everything fixed about the phase.

pub fn as_str(self) -> &'static str

The phase’s canonical name; see CreditRegistrationPhase.

pub fn from_phase_name(name: &str) -> Option<Self>

The phase Self::as_str names name, if any.

pub fn pipeline_index(self) -> usize

Where the phase sits in Self::ALL’s pipeline order, for sorting phases by it.

pub fn owned_states(self) -> &'static [CreditRegistrationState]

The ledger states this phase is the one to move a row out of.

Empty for the phases whose work is not a ledger state at all: materialize’s queue is completions with no row yet, and the syncer’s phases work on course modules. Narrower than what preconditions may claim, which is every non-terminal row: these are the states nothing else advances. How many of their rows are waiting on the phase is Self::queue_depth.

pub fn queue_depth( self, depth_of: impl Fn(CreditRegistrationState) -> i64, due_enrolment_checks: i64, ) -> i64

The live rows waiting on this phase: the Workers tab’s “queue depth it is responsible for”, and the depth the failing-phase alert asks about before calling a quiet phase wedged.

depth_of is the live count of a state. due_enrolment_checks stands in for no_usable_enrolment, whose other rows wait for their schedule rather than for the phase.

Trait Implementations

impl Clone for CreditRegistrationPhase

fn clone(&self) -> CreditRegistrationPhase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreditRegistrationPhase

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

Formats the value using the given formatter.

impl Hash for CreditRegistrationPhase

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 CreditRegistrationPhase

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

impl Eq for CreditRegistrationPhase

impl StructuralPartialEq for CreditRegistrationPhase