Struct google_drive::files::Files

pub struct Files {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Files

pub async fn list(
    &self,
    corpora: &str,
    drive_id: &str,
    include_items_from_all_drives: bool,
    include_permissions_for_view: &str,
    include_team_drive_items: bool,
    order_by: &str,
    page_size: i64,
    page_token: &str,
    q: &str,
    spaces: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    team_drive_id: &str
) -> Result<Vec<File>>

This function performs a GET to the /files endpoint.

Lists or searches files.

Parameters:

• corpora: &str – Groupings of files to which the query applies. Supported groupings are: ‘user’ (files created by, opened by, or shared directly with the user), ‘drive’ (files in the specified shared drive as indicated by the ‘driveId’), ‘domain’ (files shared to the user’s domain), and ‘allDrives’ (A combination of ‘user’ and ‘drive’ for all drives where the user is a member). When able, use ‘user’ or ‘drive’, instead of ‘allDrives’, for efficiency.
• corpus: crate::types::Corpus – The source of files to list. Deprecated: use ‘corpora’ instead.
• drive_id: &str – A link to this theme’s background image.
• include_items_from_all_drives: bool – Whether both My Drive and shared drive items should be included in results.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• include_team_drive_items: bool – Whether the user has installed the requesting app.
• order_by: &str – A comma-separated list of sort keys. Valid keys are ‘createdTime’, ‘folder’, ‘modifiedByMeTime’, ‘modifiedTime’, ‘name’, ‘name_natural’, ‘quotaBytesUsed’, ‘recency’, ‘sharedWithMeTime’, ‘starred’, and ‘viewedByMeTime’. Each key sorts ascending by default, but may be reversed with the ‘desc’ modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
• page_size: i64 – The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
• page_token: &str – The token for continuing a previous list request on the next page. This should be set to the value of ‘nextPageToken’ from the previous response.
• q: &str – A query for filtering the file results. See the “Search for Files” guide for supported syntax.
• spaces: &str – A comma-separated list of spaces to query within the corpus. Supported values are ‘drive’ and ‘appDataFolder’.
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.
• team_drive_id: &str – A link to this theme’s background image.

pub async fn list_all(
    &self,
    corpora: &str,
    drive_id: &str,
    include_items_from_all_drives: bool,
    include_permissions_for_view: &str,
    include_team_drive_items: bool,
    order_by: &str,
    q: &str,
    spaces: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    team_drive_id: &str
) -> Result<Vec<File>>

This function performs a GET to the /files endpoint.

As opposed to list, this function returns all the pages of the request at once.

Lists or searches files.

pub async fn create(
    &self,
    ignore_default_visibility: bool,
    include_permissions_for_view: &str,
    keep_revision_forever: bool,
    ocr_language: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    use_content_as_indexable_text: bool,
    body: &File
) -> Result<File>

This function performs a POST to the /files endpoint.

Creates a new file.

Parameters:

• enforce_single_parent: bool – Deprecated. Creating files in multiple folders is no longer supported.
• ignore_default_visibility: bool – Whether to ignore the domain’s default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• keep_revision_forever: bool – Whether to set the ‘keepForever’ field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
• ocr_language: &str – A language hint for OCR processing during image import (ISO 639-1 code).
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.
• use_content_as_indexable_text: bool – Whether to use the uploaded content as indexable text.

pub async fn generate_id(
    &self,
    count: i64,
    space: &str,
    type_: &str
) -> Result<GeneratedIds>

This function performs a GET to the /files/generateIds endpoint.

Generates a set of file IDs which can be provided in create or copy requests.

Parameters:

• count: i64 – A map of maximum import sizes by MIME type, in bytes.
• space: &str – The space in which the IDs can be used to create new files. Supported values are ‘drive’ and ‘appDataFolder’. (Default: ‘drive’).
• type_: &str – The type of items which the IDs can be used for. Supported values are ‘files’ and ‘shortcuts’. Note that ‘shortcuts’ are only supported in the drive ‘space’. (Default: ‘files’).

pub async fn empty_trash(&self) -> Result<()>

This function performs a DELETE to the /files/trash endpoint.

Permanently deletes all of the user’s trashed files.

Parameters:

• enforce_single_parent: bool – Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner’s root.

pub async fn get(
    &self,
    file_id: &str,
    acknowledge_abuse: bool,
    include_permissions_for_view: &str,
    supports_all_drives: bool,
    supports_team_drives: bool
) -> Result<File>

This function performs a GET to the /files/{fileId} endpoint.

Gets a file’s metadata or content by ID.

Parameters:

• file_id: &str – A link to this theme’s background image.
• acknowledge_abuse: bool – Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.

pub async fn delete(
    &self,
    file_id: &str,
    supports_all_drives: bool,
    supports_team_drives: bool
) -> Result<()>

This function performs a DELETE to the /files/{fileId} endpoint.

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.

Parameters:

• file_id: &str – A link to this theme’s background image.
• enforce_single_parent: bool – Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner’s root.
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.

pub async fn update(
    &self,
    file_id: &str,
    add_parents: &str,
    include_permissions_for_view: &str,
    keep_revision_forever: bool,
    ocr_language: &str,
    remove_parents: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    use_content_as_indexable_text: bool,
    body: &File
) -> Result<File>

This function performs a PATCH to the /files/{fileId} endpoint.

Updates a file’s metadata and/or content. This method supports patch semantics.

Parameters:

• file_id: &str – A link to this theme’s background image.
• add_parents: &str – A comma-separated list of parent IDs to add.
• enforce_single_parent: bool – Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• keep_revision_forever: bool – Whether to set the ‘keepForever’ field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
• ocr_language: &str – A language hint for OCR processing during image import (ISO 639-1 code).
• remove_parents: &str – A comma-separated list of parent IDs to remove.
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.
• use_content_as_indexable_text: bool – Whether to use the uploaded content as indexable text.

pub async fn copy(
    &self,
    file_id: &str,
    ignore_default_visibility: bool,
    include_permissions_for_view: &str,
    keep_revision_forever: bool,
    ocr_language: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    body: &File
) -> Result<File>

This function performs a POST to the /files/{fileId}/copy endpoint.

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

Parameters:

• file_id: &str – A link to this theme’s background image.
• enforce_single_parent: bool – Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.
• ignore_default_visibility: bool – Whether to ignore the domain’s default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• keep_revision_forever: bool – Whether to set the ‘keepForever’ field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
• ocr_language: &str – A language hint for OCR processing during image import (ISO 639-1 code).
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.

pub async fn export(&self, file_id: &str, mime_type: &str) -> Result<()>

This function performs a GET to the /files/{fileId}/export endpoint.

Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.

Parameters:

• file_id: &str – A link to this theme’s background image.
• mime_type: &str – The MIME type of the format requested for this export.

pub async fn watch(
    &self,
    file_id: &str,
    acknowledge_abuse: bool,
    include_permissions_for_view: &str,
    supports_all_drives: bool,
    supports_team_drives: bool,
    body: &Channel
) -> Result<Channel>

This function performs a POST to the /files/{fileId}/watch endpoint.

Subscribes to changes to a file

Parameters:

• file_id: &str – A link to this theme’s background image.
• acknowledge_abuse: bool – Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
• include_permissions_for_view: &str – Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.
• supports_all_drives: bool – Whether the requesting application supports both My Drives and shared drives.
• supports_team_drives: bool – Whether the user has installed the requesting app.

Trait Implementations

impl FileOps for Files

fn get_by_name<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    drive_id: &'life1 str,
    parent_id: &'life2 str,
    name: &'life3 str
) -> Pin<Box<dyn Future<Output = Result<Vec<File>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Get a file by it’s name.

fn create_or_update<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>(
    &'life0 self,
    drive_id: &'life1 str,
    parent_id: &'life2 str,
    name: &'life3 str,
    mime_type: &'life4 str,
    contents: &'life5 [u8]
) -> Pin<Box<dyn Future<Output = Result<File>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    'life5: 'async_trait,
    Self: 'async_trait, 

Create or update a file in a drive. If the file already exists, it will update it. If the file does not exist, it will create it.

fn download_by_id<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Bytes>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Download a file by it’s ID.

fn create_folder<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    drive_id: &'life1 str,
    parent_id: &'life2 str,
    name: &'life3 str
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Create a folder, if it doesn’t exist, returns the ID of the folder.

fn get_contents_by_id<'life0, 'life1, 'async_trait>(
    &'life0 self,
    id: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Get a file’s contents by it’s ID. Only works for Google Docs.

fn delete_by_name<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    drive_id: &'life1 str,
    parent_id: &'life2 str,
    name: &'life3 str
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Delete a file by its name.