Enum DocumentKey 

pub enum DocumentKey {
    Page(Uuid),
    Instructions {
        list: InstructionsList,
        page_id: Option<Uuid>,
    },
    ExerciseName {
        exercise_id: Uuid,
        page_id: Uuid,
    },
}

Which block document a course-wide engine read: a page or exercise text. Serialized, it is the location reported in results.

Variants

Page(Uuid)

Instructions

page_id is the page holding the exercise; None for the course default’s.

Fields

list: InstructionsList

page_id: Option<Uuid>

ExerciseName

The name, as one paragraph of rich text.

Fields

exercise_id: Uuid

page_id: Uuid

Implementations

impl DocumentKey

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

The page the document is or is on; None for the course default review instructions.

pub(crate) fn block_match( self, block: &GutenbergBlock, path: String, preview: String, ) -> BlockMatch

A match of block at path within the document, addressed as the tool that edits the document takes it.

Trait Implementations

impl Clone for DocumentKey

fn clone(&self) -> DocumentKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentKey

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

Formats the value using the given formatter.

impl Display for DocumentKey

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

Formats the value using the given formatter.

impl PartialEq for DocumentKey

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for DocumentKey

impl Eq for DocumentKey

impl StructuralPartialEq for DocumentKey