Enum InstructionsList 

pub enum InstructionsList {
    Task {
        exercise_id: Uuid,
        task_id: Uuid,
    },
    Review {
        exercise_id: Uuid,
    },
    CourseDefaultReview {
        config_id: Uuid,
    },
}

One list of instruction blocks.

Variants

Task

Fields

exercise_id: Uuid

task_id: Uuid

Review

The exercise’s own review instructions.

Fields

exercise_id: Uuid

CourseDefaultReview

The course default review config’s instructions, shared by every exercise using it.

Fields

config_id: Uuid

Implementations

impl InstructionsList

pub fn document_id(self) -> Uuid

The id the list’s document goes by in the engines: the task’s, the exercise’s or the default config’s, which no page shares.

pub fn path_prefix(self) -> String

The path patch_exercise and get_exercise address the list’s top level with.

pub fn exercise_id(self) -> Option<Uuid>

The exercise the list belongs to; None for the course default’s.

pub fn location(self) -> InstructionsLocation

Where the list is, for results.

pub fn page(self, state: &CourseState) -> Option<Uuid>

The page holding the list’s exercise in state; None for the course default’s.

pub fn validation_context(self) -> ExerciseContext

What the list’s blocks are validated as the children of.

fn stored_blocks(self, state: &CourseState) -> Option<Option<&Value>>

The stored blocks of the list in state; None if the state doesn’t have it.

pub fn document( self, state: &CourseState, ) -> Option<Result<PageDocument, EditError>>

The list in state as a document; None if the state doesn’t have it.

pub fn set_blocks(self, state: &mut CourseState, blocks: &[GutenbergBlock])

Sets the list’s blocks in state. Review instructions without content are stored as null, as the editors store them.

Trait Implementations

impl Clone for InstructionsList

fn clone(&self) -> InstructionsList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionsList

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

Formats the value using the given formatter.

impl Hash for InstructionsList

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 InstructionsList

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

impl Eq for InstructionsList

impl StructuralPartialEq for InstructionsList