Struct StudyRegistryGate 

pub(super) struct StudyRegistryGate {
    key: ScopeKey,
    phase: CreditRegistrationPhase,
    test_mode: bool,
    is_probe: bool,
    has_probed: bool,
    tally: Tally,
}

One iteration’s passage through the circuit breakers and the limiter. The adapter asks it how much it may send, spends that before sending, and records what came back; nothing else in an iteration touches breaker or rate_limit.

Fields

key: ScopeKey

phase: CreditRegistrationPhase

test_mode: bool

is_probe: bool

After a breaker’s cooldown: the iteration may send one single-item request, whichever of its flows sends it, and the breaker closes only if that request succeeds.

has_probed: bool

tally: Tally

Implementations

impl StudyRegistryGate

pub(super) fn admit( phase: CreditRegistrationPhase, scope: &RegistrationScope, test_mode: bool, ) -> Result<Self, PhaseSkipReason>

Lets the iteration run, or says why it waits. Only a phase that calls the study registry ever waits: an outage must not stall the database-only phases.

pub(super) fn is_probe(&self) -> bool

Whether the iteration is a breaker’s probe: see Self::allowance.

pub(super) fn allowance(&self, endpoint: SuotarEndpoint) -> usize

How many items one request to endpoint may carry now: its batch size, cut to what the limiter allows, or during a probe one item for the first request and none after it. For list-by-course, whose limiter counts requests, how many requests.

pub(super) fn spend(&mut self, endpoint: SuotarEndpoint, count: usize)

Spends count of what Self::allowance allowed, just before the request leaves.

pub(super) fn spend_split(&mut self, endpoint: SuotarEndpoint, count: usize)

Self::spend for the resent halves of a batch refused as malformed, which may go past the allowance; see rate_limit::overdraw.

pub(super) fn record( &mut self, endpoint: SuotarEndpoint, exchange: Exchange<'_>, )

Records what one request to endpoint came to, for Self::settle.

pub(super) fn settle(self) -> Option<String>

Applies what the iteration’s exchanges said to the breakers and the limiter, and returns the iteration’s error, if any. A request refused with its row alone is reported only when nothing answered, and counts against no breaker.

The limiter drops to its floor whenever the shared breaker trips or closes again, so the ramp back starts from the probe that got through rather than from a failure a long cooldown ago.