Struct Folder 

pub struct Folder {

    pub id: u64,
    pub name: Option<String>,
    pub full_name: Option<String>,
    pub context_id: Option<u64>,
    pub context_type: Option<String>,
    pub parent_folder_id: Option<u64>,
    pub created_at: Option<DateTime<Utc>>,
    pub updated_at: Option<DateTime<Utc>>,
    pub lock_at: Option<DateTime<Utc>>,
    pub unlock_at: Option<DateTime<Utc>>,
    pub position: Option<u64>,
    pub locked: Option<bool>,
    pub folders_url: Option<String>,
    pub files_url: Option<String>,
    pub files_count: Option<u64>,
    pub folders_count: Option<u64>,
    pub hidden: Option<bool>,
    pub locked_for_user: Option<bool>,
    pub hidden_for_user: Option<bool>,
    pub for_submissions: Option<bool>,
    pub can_upload: Option<bool>,
    /* private fields */
}

A folder in the Canvas file storage system.

Fields

id: u64

name: Option<String>

full_name: Option<String>

context_id: Option<u64>

context_type: Option<String>

parent_folder_id: Option<u64>

created_at: Option<DateTime<Utc>>

updated_at: Option<DateTime<Utc>>

lock_at: Option<DateTime<Utc>>

unlock_at: Option<DateTime<Utc>>

position: Option<u64>

locked: Option<bool>

folders_url: Option<String>

files_url: Option<String>

files_count: Option<u64>

folders_count: Option<u64>

hidden: Option<bool>

locked_for_user: Option<bool>

hidden_for_user: Option<bool>

for_submissions: Option<bool>

can_upload: Option<bool>

Implementations

impl Folder

pub async fn update(&self, params: UpdateFolderParams) -> Result<Folder>

Update this folder’s name, parent, or lock state.

Canvas API

PUT /api/v1/folders/:id

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

Delete this folder.

Canvas API

DELETE /api/v1/folders/:id

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

Stream all files in this folder.

Canvas API

GET /api/v1/folders/:id/files

pub fn get_folders(&self) -> PageStream<Folder>

Stream all subfolders in this folder.

Canvas API

GET /api/v1/folders/:id/folders

pub async fn create_folder(&self, name: &str) -> Result<Folder>

Create a subfolder inside this folder.

Canvas API

POST /api/v1/folders/:id/folders

pub async fn copy_file(&self, source_file_id: u64) -> Result<File>

Copy a file into this folder.

Canvas API

POST /api/v1/folders/:dest_folder_id/copy_file

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

Upload a file to this folder.

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/folders/:id/files

Trait Implementations

impl Clone for Folder

fn clone(&self) -> Folder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Folder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Folder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Folder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.