Struct StructureEditor 

pub(super) struct StructureEditor<'c> {
    doc: CourseStructure,
    labels: Labels,
    removed: HashMap<Uuid, usize>,
    pub(super) ids: CreatedIdLog<'c>,
    pub(super) warnings: Vec<Warning>,
    paths: PathRequests,
    new_pages: HashMap<Uuid, Vec<GutenbergBlock>>,
    page_copies: Vec<PageCopy>,
    page_pairings: BTreeMap<Uuid, Uuid>,
    front_page: Option<Uuid>,
    course_is_live: bool,
}

Fields

doc: CourseStructure

labels: Labels

removed: HashMap<Uuid, usize>

ids: CreatedIdLog<'c>

warnings: Vec<Warning>

paths: PathRequests

new_pages: HashMap<Uuid, Vec<GutenbergBlock>>

page_copies: Vec<PageCopy>

page_pairings: BTreeMap<Uuid, Uuid>

front_page: Option<Uuid>

The course front page, /, which stays first in /course/pages with its path.

course_is_live: bool

Implementations

impl<'c> StructureEditor<'c>

pub(super) fn new( doc: &CourseStructure, ops: &[Op], course_is_live: bool, ids: &'c dyn IdGenerator, ) -> Self

pub(super) fn apply_op(&mut self, op: &Op) -> Result<(), EditError>

fn require(&self, id: Uuid) -> Result<Loc, EditError>

fn not_found(&self, id: Uuid) -> EditError

fn address(&self, path: &str) -> Result<Address, EditError>

fn list_ids(&self, list: ListRef) -> Vec<Uuid>

fn take(&mut self, list: ListRef, start: usize, end: usize) -> Vec<Entity>

fn put( &mut self, list: ListRef, index: usize, entities: Vec<Entity>, ) -> Result<(), EditError>

fn anchor( &self, address: &Address, position: Option<Position>, ) -> Result<Anchor<ListRef>, EditError>

fn resolve_anchor( &self, anchor: Anchor<ListRef>, kind: Kind, ) -> Result<(ListRef, usize), EditError>

(list, index) for an anchor in the current tree, checking the pinned positions.

fn pinned_first(&self, list: ListRef) -> Option<(EditErrorCode, Uuid)>

What list keeps first, with the error code for disturbing it: the course front page in /course/pages and the default module in /course/modules.

fn range( &self, from: Uuid, through: Option<Uuid>, ) -> Result<(Loc, usize), EditError>

fn sibling_paths(&self, list: ListRef) -> Vec<String>

fn check_not_pinned( &self, list: ListRef, start: usize, action: &str, ) -> Result<(), EditError>

fn new_entities( &mut self, kind: Kind, value: &Value, ) -> Result<Vec<Entity>, EditError>

fn new_entity(&mut self, kind: Kind, value: &Value) -> Result<Entity, EditError>

fn new_page( &mut self, object: &Map<String, Value>, ) -> Result<StructurePage, EditError>

fn materialize_blocks( &mut self, page_id: Uuid, value: &Value, ) -> Result<Vec<GutenbergBlock>, EditError>

Builds a new page’s blocks with the page tool’s rules.

fn add( &mut self, path: &str, value: &Value, position: Option<Position>, ) -> Result<(), EditError>

fn entity_at(&self, path: &str, message: &str) -> Result<Uuid, EditError>

The entity path names; any other address fails with message.

fn remove(&mut self, path: &str, through: Option<&str>) -> Result<(), EditError>

fn replace(&mut self, path: &str, value: &Value) -> Result<(), EditError>

fn field_value(&self, id: Uuid, kind: Kind, field: &str) -> Option<Value>

fn set_field( &mut self, id: Uuid, field: &str, value: Value, ) -> Result<(), EditError>

Sets one editable field; Value::Null clears it. field passed check_field.

fn move_entities(&mut self, transfer: &Transfer) -> Result<(), EditError>

fn copy( &mut self, transfer: &Transfer, label: Option<&str>, ) -> Result<(), EditError>

fn copy_page(&mut self, source: &StructurePage) -> StructurePage

fn reorder(&mut self, path: &str, value: &Value) -> Result<(), EditError>

pub(super) fn finish( self, before: &CourseStructure, ) -> Result<StructureResult, EditError>

fn check_final_invariants(&self) -> Result<(), EditError>

What every op keeps, checked once more on the result: the pinned first items, module names and chapter front pages.

fn renumber_chapters( &mut self, before: &CourseStructure, ) -> Vec<ChapterRenumber>

Numbers the chapters 1, 2, … in order and lists the ones whose number changed from before.