Struct CourseBuilder

pub struct CourseBuilder {

    pub name: String,
    pub slug: String,
    pub language_code: String,
    pub can_add_chatbot: bool,
    pub description: String,
    pub default_instance_name: &'static [u8],
    pub modules: Vec<ModuleBuilder>,
    pub extra_roles: Vec<(Uuid, UserRole)>,
    pub course_id: Option<Uuid>,
    pub instances: Vec<CourseInstanceConfig>,
    pub pages: Vec<PageConfig>,
    pub glossary_entries: Vec<GlossaryEntry>,
    pub certificate_config: Option<CertificateConfig>,
    pub front_page_content: Option<Vec<GutenbergBlock>>,
}

Builder for courses with modules, chapters, pages, and exercises.

Fields

name: String

slug: String

language_code: String

can_add_chatbot: bool

description: String

default_instance_name: &'static [u8]

modules: Vec<ModuleBuilder>

extra_roles: Vec<(Uuid, UserRole)>

course_id: Option<Uuid>

instances: Vec<CourseInstanceConfig>

pages: Vec<PageConfig>

glossary_entries: Vec<GlossaryEntry>

certificate_config: Option<CertificateConfig>

front_page_content: Option<Vec<GutenbergBlock>>

Implementations

impl CourseBuilder

pub fn new(name: impl Into<String>, slug: impl Into<String>) -> Self

pub fn chatbot(self, v: bool) -> Self

pub fn desc(self, d: impl Into<String>) -> Self

pub fn language(self, lc: impl Into<String>) -> Self

pub fn module(self, m: ModuleBuilder) -> Self

pub fn modules<I: IntoIterator<Item = ModuleBuilder>>(self, it: I) -> Self

pub fn role(self, user_id: Uuid, role: UserRole) -> Self

pub fn course_id(self, id: Uuid) -> Self

pub fn instance(self, config: CourseInstanceConfig) -> Self

pub fn top_level_page( self, url: impl Into<String>, title: impl Into<String>, page_number: i32, is_hidden: bool, content: Option<Vec<GutenbergBlock>>, ) -> Self

Add a top-level page to the course

pub fn glossary_entry( self, acronym: impl Into<String>, definition: impl Into<String>, ) -> Self

pub fn certificate_config( self, background_svg_path: impl Into<String>, certificate_id: Option<Uuid>, ) -> Self

pub fn front_page_content(self, content: Vec<GutenbergBlock>) -> Self

Set custom content for the course front page. If not set, default content will be used.

pub async fn seed( self, cx: &mut SeedContext<'_>, ) -> Result<(Course, CourseInstance, CourseModule)>

Seeds the course and all nested content. Returns (course, default_instance, last_module).

Trait Implementations

impl Clone for CourseBuilder

fn clone(&self) -> CourseBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CourseBuilder

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

Formats the value using the given formatter.