Struct CourseStructure 

pub struct CourseStructure {
    pub id: Uuid,
    pub pages: Vec<StructurePage>,
    pub modules: Vec<StructureModule>,
}

The course tree as agents read and edit it. Children arrays are in display order.

Fields

id: Uuid

pages: Vec<StructurePage>

Pages outside chapters; the course front page (/) is always first.

modules: Vec<StructureModule>

The default module is always first.

Implementations

impl CourseStructure

pub fn modules(&self) -> impl Iterator<Item = &StructureModule>

The modules in order.

pub fn chapters(&self) -> impl Iterator<Item = &StructureChapter>

Every chapter, in course order.

pub(crate) fn chapters_mut( &mut self, ) -> impl Iterator<Item = &mut StructureChapter>

Self::chapters for editing.

pub fn pages( &self, ) -> impl Iterator<Item = (Option<&StructureChapter>, &StructurePage)>

Every page with the chapter it belongs to.

pub(crate) fn pages_mut(&mut self) -> impl Iterator<Item = &mut StructurePage>

Every page, top-level ones first.

pub fn page(&self, page_id: Uuid) -> Option<&StructurePage>

The page page_id, wherever it is.

pub(crate) fn page_mut(&mut self, page_id: Uuid) -> Option<&mut StructurePage>

Self::page for editing.

pub fn chapter_of_page(&self, page_id: Uuid) -> Option<&StructureChapter>

The chapter holding the page; None for a page outside chapters.

pub fn is_chapter_front_page(&self, page_id: Uuid) -> bool

Whether the page is the first of its chapter.

pub fn module(&self, id: Uuid) -> Option<&StructureModule>

The module id.

pub(crate) fn module_mut(&mut self, id: Uuid) -> Option<&mut StructureModule>

Self::module for editing.

pub fn chapter(&self, id: Uuid) -> Option<&StructureChapter>

The chapter id.

pub(crate) fn chapter_mut(&mut self, id: Uuid) -> Option<&mut StructureChapter>

Self::chapter for editing.

pub(crate) fn locate(&self, id: Uuid) -> Option<Loc>

Where the module, chapter or page id is.

pub(crate) fn list(&self, list: ListRef) -> Vec<EntityRef<'_>>

The entities of list in order; none when its owner doesn’t exist.

Trait Implementations

impl Clone for CourseStructure

fn clone(&self) -> CourseStructure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CourseStructure

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

Formats the value using the given formatter.

impl PartialEq for CourseStructure

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CourseStructure