Crate canvas_lms_connector

Canvas API Integration Library

This Rust library provides functionalities for interacting with the Canvas Learning Management System (LMS) API. It simplifies tasks like retrieving course information, managing student data, and processing assignments and submissions. The library utilizes the reqwest crate for HTTP requests and incorporates concurrency control for efficient request handling.

Core Features

• Authentication and Configuration: Handles Canvas API credentials, supporting both file-based and system keyring storage.
• Course Management: Facilitates access to course information, enabling users to interact with course details.
• Student Management: Provides functionalities to manage student data within courses.
• Assignments and Submissions Handling: Allows for retrieval and updating of assignment information and student submissions.

Usage

To use this library, add it as a dependency in your Cargo.toml. Use the provided structures and functions to interact with the Canvas API as per your application’s requirements.

[dependencies]
canvas_lms_connector = "0.1"

After adding the library as a dependency, you can use its features in your Rust application.

The primary functions are fetch_courses_with_credentials and fetch_single_course_with_credentials.

• fetch_courses_with_credentials retrieves a list of courses using provided Canvas API credentials.
• fetch_single_course_with_credentials fetches details of a specific course using the given credentials.

Both functions require a reference to CanvasCredentials, which contain the necessary API URL and token. They return results encapsulated in CanvasResultCourses or CanvasResultSingleCourse enums, representing either successful data retrieval or an error (connection or credential issues).

Examples

Fetching a list of courses:

let canvas_credentials = CanvasCredentials { /* ... */ };
match Canvas::fetch_courses_with_credentials(&canvas_credentials) {
    CanvasResultCourses::Ok(courses) => println!("Courses: {:?}", courses),
    CanvasResultCourses::ErrConnection(err) => eprintln!("Connection error: {}", err),
    CanvasResultCourses::ErrCredentials(err) => eprintln!("Credentials error: {}", err),
}

Fetching a specific course by ID:

let canvas_credentials = CanvasCredentials { /* ... */ };
let course_id = 123;
match Canvas::fetch_single_course_with_credentials(&canvas_credentials, course_id) {
    CanvasResultSingleCourse::Ok(course) => println!("Course: {:?}", course),
    CanvasResultSingleCourse::ErrConnection(err) => eprintln!("Connection error: {}", err),
    CanvasResultSingleCourse::ErrCredentials(err) => eprintln!("Credentials error: {}", err),
}

Re-exports

pub use credentials::CanvasCredentials;

pub use course::Course;

pub use course::CourseInfo;

pub use canvas::Canvas;

pub use canvas::CanvasResultCourses;

pub use canvas::CanvasResultSingleCourse;

Modules

canvas

course

credentials

Structs

Assignment

High-level structure representing an assignment within the Canvas Learning Management System.

AssignmentInfo

Structure to hold detailed information about an assignment in the Canvas system.

Student

High-level representation of a student in the Canvas Learning Management System.

StudentInfo

Structure for storing and managing student data in the Canvas system.

Submission

Structure representing a student’s submission for an assignment in the Canvas Learning Management System.