Struct Canvas 

pub struct Canvas { /* private fields */ }

The Canvas LMS API client. All interaction starts here.

Example

let canvas = canvas_lms_api::Canvas::new("https://canvas.example.edu", "my-token")?;
let course = canvas.get_course(1).await?;
println!("{}", course.name.unwrap_or_default());

Implementations

impl Canvas

pub fn new(base_url: &str, access_token: &str) -> Result<Self>

Create a new Canvas client.

base_url should be the institution root (e.g. https://canvas.example.edu), not including /api/v1.

pub fn with_client( base_url: &str, access_token: &str, client: Client, ) -> Result<Self>

Create a Canvas client with a custom reqwest::Client (for proxy, TLS config, etc.).

pub async fn get_course(&self, course_id: u64) -> Result<Course>

Fetch a single course by ID.

Canvas API

GET /api/v1/courses/:id

pub fn get_courses(&self) -> PageStream<Course>

Stream all courses visible to the authenticated user.

Canvas API

GET /api/v1/courses

pub async fn create_course( &self, account_id: u64, params: CreateCourseParams, ) -> Result<Course>

Create a new course under an account.

Canvas API

POST /api/v1/accounts/:account_id/courses

pub async fn delete_course(&self, course_id: u64) -> Result<Course>

Delete a course by ID. Canvas returns the deleted course object.

Canvas API

DELETE /api/v1/courses/:id

pub async fn get_user(&self, user_id: UserId) -> Result<User>

Fetch a single user by ID or UserId::Current for the authenticated user.

Canvas API

GET /api/v1/users/:id

pub async fn get_current_user(&self) -> Result<CurrentUser>

Fetch the currently authenticated user.

Canvas API

GET /api/v1/users/self

pub async fn create_user( &self, account_id: u64, params: CreateUserParams, ) -> Result<User>

Create a new user under an account.

Canvas API

POST /api/v1/accounts/:account_id/users

pub async fn get_account(&self, account_id: u64) -> Result<Account>

Fetch a single account by ID.

Canvas API

GET /api/v1/accounts/:id

pub async fn get_outcome(&self, outcome_id: u64) -> Result<Outcome>

Fetch a single outcome by ID.

Canvas API

GET /api/v1/outcomes/:id

pub fn get_accounts(&self) -> PageStream<Account>

Stream all accounts accessible to the authenticated user.

Canvas API

GET /api/v1/accounts