Struct Module 

pub struct Module {

    pub id: u64,
    pub course_id: Option<u64>,
    pub name: Option<String>,
    pub position: Option<u64>,
    pub unlock_at: Option<DateTime<Utc>>,
    pub require_sequential_progress: Option<bool>,
    pub prerequisite_module_ids: Option<Vec<u64>>,
    pub items_count: Option<u64>,
    pub items_url: Option<String>,
    pub state: Option<String>,
    pub completed_at: Option<DateTime<Utc>>,
    pub publish_final_grade: Option<bool>,
    pub published: Option<bool>,
    /* private fields */
}

A Canvas course module (a collection of ordered content items).

Fields

id: u64

course_id: Option<u64>

name: Option<String>

position: Option<u64>

unlock_at: Option<DateTime<Utc>>

require_sequential_progress: Option<bool>

prerequisite_module_ids: Option<Vec<u64>>

items_count: Option<u64>

items_url: Option<String>

state: Option<String>

completed_at: Option<DateTime<Utc>>

publish_final_grade: Option<bool>

published: Option<bool>

Implementations

impl Module

pub async fn edit(&self, params: UpdateModuleParams) -> Result<Module>

Edit this module’s settings.

Canvas API

PUT /api/v1/courses/:course_id/modules/:id

pub async fn delete(&self) -> Result<Module>

Delete this module.

Canvas API

DELETE /api/v1/courses/:course_id/modules/:id

pub async fn relock(&self) -> Result<Module>

Re-lock this module’s progressions.

Canvas API

PUT /api/v1/courses/:course_id/modules/:id/relock

pub fn get_module_items(&self) -> PageStream<ModuleItem>

Stream all items in this module.

Canvas API

GET /api/v1/courses/:course_id/modules/:id/items

pub async fn get_module_item(&self, item_id: u64) -> Result<ModuleItem>

Fetch a single module item by ID.

Canvas API

GET /api/v1/courses/:course_id/modules/:id/items/:item_id

pub async fn create_module_item( &self, params: CreateModuleItemParams, ) -> Result<ModuleItem>

Create a new item in this module.

Canvas API

POST /api/v1/courses/:course_id/modules/:id/items

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Module

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Module

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

where __S: Serializer,

Serialize this value into the given Serde serializer.