Struct trane::data::CourseManifestBuilder

impl CourseManifestBuilder

pub fn id<VALUE: Into<Ustr>>(&mut self, value: VALUE) -> &mut Self

The ID assigned to this course.

For example, music::instrument::guitar::basic_jazz_chords.

pub fn name(&mut self, value: String) -> &mut Self

The name of the course to be presented to the user.

For example, “Basic Jazz Chords on Guitar”.

pub fn dependencies(&mut self, value: Vec<Ustr>) -> &mut Self

The IDs of all dependencies of this course.

pub fn description(&mut self, value: Option<String>) -> &mut Self

An optional description of the course.

pub fn authors(&mut self, value: Option<Vec<String>>) -> &mut Self

An optional list of the course’s authors.

pub fn metadata( &mut self, value: Option<BTreeMap<String, Vec<String>>> ) -> &mut Self

be attached to a course named “Basic Jazz Chords on Guitar”.

The purpose of this metadata is to allow students to focus on more specific material during a study session which does not belong to a single lesson or course. For example, a student might want to only focus on guitar scales or ear training.

pub fn course_material(&mut self, value: Option<BasicAsset>) -> &mut Self

An optional asset, which presents the material covered in the course.

pub fn course_instructions(&mut self, value: Option<BasicAsset>) -> &mut Self

An optional asset, which presents instructions common to all exercises in the course.

pub fn generator_config(&mut self, value: Option<CourseGenerator>) -> &mut Self

An optional configuration to generate material for this course. Generated courses allow easier creation of courses for specific purposes without requiring the manual creation of all the files a normal course would need.

pub fn build(&self) -> Result<CourseManifest, CourseManifestBuilderError>

Builds a new CourseManifest.

Errors

If a required field has not been initialized.

Trait Implementations§

impl Clone for CourseManifestBuilder

fn clone(&self) -> CourseManifestBuilder

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Default for CourseManifestBuilder

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl UnwindSafe for CourseManifestBuilder

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.