canvas-lms-api 0.4.0

Rust client for the Instructure Canvas LMS REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

use thiserror::Error;

#[derive(Debug, Error)]
pub enum CanvasError {
    #[error("Bad request: {message}")]
    BadRequest {
        message: String,
        errors: Vec<ApiError>,
    },

    #[error("Invalid access token: {0}")]
    InvalidAccessToken(String),

    #[error("Unauthorized: {0}")]
    Unauthorized(String),

    #[error("Forbidden: {0}")]
    Forbidden(String),

    #[error("Resource does not exist")]
    ResourceDoesNotExist,

    #[error("Conflict: {0}")]
    Conflict(String),

    #[error("Unprocessable entity: {0}")]
    UnprocessableEntity(String),

    #[error("Rate limit exceeded (X-Rate-Limit-Remaining: {remaining:?})")]
    RateLimitExceeded { remaining: Option<String> },

    #[error("Canvas API error (status {status}): {message}")]
    ApiError { status: u16, message: String },

    #[error(transparent)]
    Http(#[from] reqwest::Error),

    #[error(transparent)]
    Json(#[from] serde_json::Error),

    #[error(transparent)]
    Url(#[from] url::ParseError),

    #[error(transparent)]
    Io(#[from] std::io::Error),
}

#[derive(Debug, Clone, serde::Deserialize)]
pub struct ApiError {
    pub message: Option<String>,
    #[serde(rename = "type")]
    pub error_type: Option<String>,
}

#[derive(Debug, serde::Deserialize)]
pub(crate) struct CanvasErrorBody {
    pub errors: Option<Vec<ApiError>>,
    pub error: Option<String>,
    #[allow(dead_code)] // surfaced in future error reporting
    pub error_report_id: Option<u64>,
}

pub type Result<T> = std::result::Result<T, CanvasError>;