Struct SuotarStudyRegistry 

pub(super) struct SuotarStudyRegistry<'a> {
    client: &'a SuotarClient,
    worker_name: String,
    gate: StudyRegistryGate,
}

The StudyRegistry over Suotar for one phase iteration: every request is spent through, and recorded in, the iteration’s gate.

Fields

client: &'a SuotarClient

worker_name: String

The audit log’s worker_name for every call.

gate: StudyRegistryGate

Implementations

impl<'a> SuotarStudyRegistry<'a>

pub(super) fn admit( client: &'a SuotarClient, worker_name: String, phase: CreditRegistrationPhase, scope: &RegistrationScope, test_mode: bool, ) -> Result<Self, PhaseSkipReason>

The registry one phase iteration sends through, or why the iteration waits.

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

Applies what the iteration’s calls said to the breakers and the limiter, and returns the iteration’s error, if any.

fn call_context(&self, registration_ids: Vec<Uuid>) -> SuotarCallContext

Trait Implementations

impl StudyRegistry for SuotarStudyRegistry<'_>

fn allowance(&self, operation: RegistryOperation) -> usize

How many items the next request of operation may carry, or for a roster listing how many requests may go out. 0 means send nothing this iteration.

fn roster_request_size(&self) -> usize

How many course codes one roster listing request may carry: the registry’s batch size, or one while a breaker’s probe lets a single item through.

async fn resolve_persons<K>( &mut self, entries: Vec<BatchEntry<K, PersonLookup>>, options: BatchOptions, ) -> BatchReply<K, PersonLookup, PersonAnswer>

async fn resolve_enrolments<K>( &mut self, entries: Vec<BatchEntry<K, EnrolmentLookup>>, options: BatchOptions, ) -> BatchReply<K, EnrolmentLookup, EnrolmentAnswer>

async fn import_attainments<K>( &mut self, entries: Vec<BatchEntry<K, AttainmentSubmission>>, options: BatchOptions, ) -> BatchReply<K, AttainmentSubmission, ImportAnswer>

The one operation that creates something: a row it leaves unanswered may have landed.

async fn verify_attainments<K>( &mut self, entries: Vec<BatchEntry<K, VerificationRequest>>, options: BatchOptions, ) -> BatchReply<K, VerificationRequest, VerificationAnswer>

async fn list_course_roster( &mut self, request: &[RosterCode], ) -> Result<RosterListing, RegistryError>

One list-by-course request, spending one request of the allowance.

async fn validate_course_codes( &mut self, codes: &[CourseCode], ) -> Result<HashMap<CourseCode, CourseCodeVerdict>, RegistryError>

Validates codes in requests as large as the allowance lets, until either runs out. On the first refused request the verdicts gathered so far are dropped.