Struct Course 

pub struct Course {

    pub id: u64,
    pub name: Option<String>,
    pub course_code: Option<String>,
    pub workflow_state: Option<WorkflowState>,
    pub account_id: Option<u64>,
    pub root_account_id: Option<u64>,
    pub enrollment_term_id: Option<u64>,
    pub sis_course_id: Option<String>,
    pub start_at: Option<DateTime<Utc>>,
    pub end_at: Option<DateTime<Utc>>,
    pub grading_standard_id: Option<u64>,
    pub is_public: Option<bool>,
    pub license: Option<String>,
    pub locale: Option<String>,
    pub time_zone: Option<String>,
    pub total_students: Option<u64>,
    pub default_view: Option<String>,
    pub syllabus_body: Option<String>,
    pub public_description: Option<String>,
    pub hide_final_grades: Option<bool>,
    pub apply_assignment_group_weights: Option<bool>,
    pub restrict_enrollments_to_course_dates: Option<bool>,
    /* private fields */
}

Fields

id: u64

name: Option<String>

course_code: Option<String>

workflow_state: Option<WorkflowState>

account_id: Option<u64>

root_account_id: Option<u64>

enrollment_term_id: Option<u64>

sis_course_id: Option<String>

start_at: Option<DateTime<Utc>>

end_at: Option<DateTime<Utc>>

grading_standard_id: Option<u64>

is_public: Option<bool>

license: Option<String>

locale: Option<String>

time_zone: Option<String>

total_students: Option<u64>

default_view: Option<String>

syllabus_body: Option<String>

public_description: Option<String>

hide_final_grades: Option<bool>

apply_assignment_group_weights: Option<bool>

restrict_enrollments_to_course_dates: Option<bool>

Implementations

impl Course

pub fn get_assignments(&self) -> PageStream<Assignment>

Stream all assignments in this course.

Canvas API

GET /api/v1/courses/:course_id/assignments

pub async fn get_assignment(&self, assignment_id: u64) -> Result<Assignment>

Fetch a single assignment.

Canvas API

GET /api/v1/courses/:course_id/assignments/:id

pub async fn create_assignment( &self, params: CreateAssignmentParams, ) -> Result<Assignment>

Create a new assignment in this course.

Canvas API

POST /api/v1/courses/:id/assignments

pub fn get_sections(&self) -> PageStream<Section>

Stream all sections in this course.

Canvas API

GET /api/v1/courses/:course_id/sections

pub async fn get_section(&self, section_id: u64) -> Result<Section>

Fetch a single section by ID.

Canvas API

GET /api/v1/courses/:id/sections/:section_id

pub fn get_enrollments(&self) -> PageStream<Enrollment>

Stream all enrollments in this course.

Canvas API

GET /api/v1/courses/:course_id/enrollments

pub fn get_users(&self) -> PageStream<User>

Stream all users in this course.

Canvas API

GET /api/v1/courses/:course_id/users

pub async fn update(&self, params: UpdateCourseParams) -> Result<Course>

Update this course.

Canvas API

PUT /api/v1/courses/:id

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

Delete this course. Canvas returns the deleted course object.

Canvas API

DELETE /api/v1/courses/:id

pub fn get_quizzes(&self) -> PageStream<Quiz>

Stream all quizzes in this course.

Canvas API

GET /api/v1/courses/:id/quizzes

pub async fn get_quiz(&self, quiz_id: u64) -> Result<Quiz>

Fetch a single quiz.

Canvas API

GET /api/v1/courses/:id/quizzes/:quiz_id

pub async fn create_quiz(&self, params: CreateQuizParams) -> Result<Quiz>

Create a new quiz in this course.

Canvas API

POST /api/v1/courses/:id/quizzes

pub fn get_modules(&self) -> PageStream<Module>

Stream all modules in this course.

Canvas API

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

pub async fn get_module(&self, module_id: u64) -> Result<Module>

Fetch a single module.

Canvas API

GET /api/v1/courses/:id/modules/:module_id

pub fn get_pages(&self) -> PageStream<Page>

Stream all pages in this course.

Canvas API

GET /api/v1/courses/:id/pages

pub async fn get_page(&self, url_or_id: &str) -> Result<Page>

Fetch a single page by URL slug or ID.

Canvas API

GET /api/v1/courses/:id/pages/:url_or_id

pub fn get_discussion_topics(&self) -> PageStream<DiscussionTopic>

Stream all discussion topics in this course.

Canvas API

GET /api/v1/courses/:id/discussion_topics

pub async fn get_discussion_topic( &self, topic_id: u64, ) -> Result<DiscussionTopic>

Fetch a single discussion topic.

Canvas API

GET /api/v1/courses/:id/discussion_topics/:topic_id

pub fn get_files(&self) -> PageStream<File>

Stream all files in this course.

Canvas API

GET /api/v1/courses/:id/files

pub fn get_tabs(&self) -> PageStream<Tab>

Stream all tabs in this course.

Canvas API

GET /api/v1/courses/:id/tabs

pub fn get_groups(&self) -> PageStream<Group>

Stream all groups in this course.

Canvas API

GET /api/v1/courses/:id/groups

pub async fn upload_file( &self, request: UploadRequest, data: Vec<u8>, ) -> Result<File>

Upload a file to this course.

Canvas uses a two-step upload: first POSTing metadata to obtain an upload URL, then POSTing the file as multipart form data to that URL.

Canvas API

POST /api/v1/courses/:id/files

Trait Implementations

impl Clone for Course

fn clone(&self) -> Course

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Course

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Course

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Course

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

where __S: Serializer,

Serialize this value into the given Serde serializer.