Enum CreditRegistrationPhase 

pub enum CreditRegistrationPhase {
    Materialize,
    Preconditions,
    ResolveEnrolments,
    Import,
    Verify,
    LegacyMirror,
    StudentNotifications,
    EnrolmentDiscovery,
    LinkEmails,
    ProductTokenRefresh,
    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

ProductTokenRefresh

ConfigValidation

RetentionSweep

LedgerSnapshot

Implementations

impl CreditRegistrationPhase

pub const ALL: [Self; 13]

Every phase, in pipeline order.

pub const REGISTRAR_TICK_SEQUENCE: [Self; 5]

The phases run-registrar-tick runs, in pipeline order. Not every credit-registrar phase: legacy-mirror and student-notifications are driven explicitly by specs that need them.

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

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

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

Which worker process owns the phase’s loop.

pub fn calls_study_registry(self) -> bool

Whether the phase talks to the study registry, and so shares the circuit breaker with the other such phases of its own worker process (breaker::BREAKERS is process-local, not shared between credit-registrar and suotar-syncer).

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

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

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. 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.

pub fn scope_support(self) -> ScopeSupport

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