Struct InMemoryUnitGraph 

pub struct InMemoryUnitGraph { /* private fields */ }

An implementation of UnitGraph describing the units and relationships as an adjacency list stored in hash maps. All of it is stored in memory, as the memory benchmarks show that less than 20 MB of memory are used even when opening a large Trane library.

Trait Implementations

impl Clone for InMemoryUnitGraph

fn clone(&self) -> InMemoryUnitGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InMemoryUnitGraph

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

Formats the value using the given formatter.

impl Default for InMemoryUnitGraph

fn default() -> InMemoryUnitGraph

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InMemoryUnitGraph

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InMemoryUnitGraph

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UnitGraph for InMemoryUnitGraph

fn add_course(&mut self, course_id: Ustr) -> Result<(), UnitGraphError>

Adds a new course to the unit graph.

fn add_lesson( &mut self, lesson_id: Ustr, course_id: Ustr, ) -> Result<(), UnitGraphError>

Adds a new lesson to the unit graph. It also takes the ID of the course to which this lesson belongs.

fn add_exercise( &mut self, exercise_id: Ustr, lesson_id: Ustr, ) -> Result<(), UnitGraphError>

Adds a new exercise to the unit graph. It also takes the ID of the lesson to which this exercise belongs.

fn add_dependencies( &mut self, unit_id: Ustr, unit_type: UnitType, dependencies: &[Ustr], ) -> Result<(), UnitGraphError>

Takes a unit and its dependencies and updates the graph accordingly. Returns an error if unit_type is UnitType::Exercise as only courses and lessons are allowed to have dependencies. An error is also returned if the unit was not previously added by calling one of add_course or add_lesson.

fn add_encompassed( &mut self, unit_id: Ustr, dependencies: &[Ustr], encompassed: &[(Ustr, f32)], ) -> Result<(), UnitGraphError>

Adds the list of encompassed units for the given unit to the graph. Dependencies not in the list of encompassed units are added with a default weight of 1.0. Returns an error if any of the weights are not within the range [0.0, 1.0].

fn set_encompasing_equals_dependency(&mut self)

Tells UnitGraph that the encompassing and dependency graphs are the same. That is, no manifest explicitly declared encompassed units. In this case, the encompassing graph is identical to the dependency graph with all weights set to 1.0. The caller should use this function after building the full graph to avoid the overhead of storing two identical graphs.

fn encompasing_equals_dependency(&self) -> bool

Whether the encompassing and dependency graphs are effectively the same.

fn add_superseded(&mut self, unit_id: Ustr, superseded: &[Ustr])

Adds the list of superseded units for the given unit to the graph.

fn get_unit_type(&self, unit_id: Ustr) -> Option<UnitType>

Returns the type of the given unit.

fn get_course_lessons(&self, course_id: Ustr) -> Option<UstrSet>

Returns the lessons belonging to the given course.

fn get_starting_lessons(&self, course_id: Ustr) -> Option<UstrSet>

Returns the starting lessons for the given course.

fn update_starting_lessons(&mut self)

Updates the starting lessons for all courses. The starting lessons of the course are those of its lessons that should be practiced first when the course is introduced to the student. The scheduler uses them to traverse through the other lessons in the course in the correct order. This function should be called once after all the courses and lessons have been added to the graph.

fn get_lesson_course(&self, lesson_id: Ustr) -> Option<Ustr>

Returns the course to which the given lesson belongs.

fn get_lesson_exercises(&self, lesson_id: Ustr) -> Option<UstrSet>

Returns the exercises belonging to the given lesson.

fn get_exercise_lesson(&self, exercise_id: Ustr) -> Option<Ustr>

Returns the lesson to which the given exercise belongs.

fn get_dependencies(&self, unit_id: Ustr) -> Option<UstrSet>

Returns the weights of the dependencies of the given unit.

fn get_dependents(&self, unit_id: Ustr) -> Option<UstrSet>

Returns all the units which depend on the given unit.

fn get_dependency_sinks(&self) -> UstrSet

Returns the dependency sinks of the graph. A dependency sink is a unit with no dependencies from which a walk of the entire unit graph needs to start. Because the lessons in a course implicitly depend on their course, properly initialized lessons do not belong to this set.

fn get_encompasses(&self, unit_id: Ustr) -> Option<Vec<(Ustr, f32)>>

Returns the units that this unit encompasses.

fn get_encompassed_by(&self, unit_id: Ustr) -> Option<Vec<(Ustr, f32)>>

Returns the units that the given unit is encompassed by.

fn get_supersedes(&self, unit_id: Ustr) -> Option<UstrSet>

Returns the units that this unit supersedes.

fn get_superseded_by(&self, unit_id: Ustr) -> Option<UstrSet>

Returns the units that the given unit is superseded by.

fn check_cycles(&self) -> Result<(), UnitGraphError>

Performs a cycle check on the graph, done currently when opening the Trane library to prevent any infinite traversal of the graph and immediately inform the user of the issue.

fn generate_dot_graph(&self, courses_only: bool) -> String

Generates a DOT graph of the dependent graph. DOT files are used by Graphviz to visualize a graph, in this case the dependent graph. This operation was suggested in issue #13 in the trane-cli repo.

impl StructuralPartialEq for InMemoryUnitGraph