Struct google_drive2::api::FileInsertCall[][src]

pub struct FileInsertCall<'a> { /* fields omitted */ }

Insert a new file.

A builder for the insert method supported by a file resource. It is not used directly, but through a FileMethods instance.

Example

Instantiate a resource method builder

use drive2::api::File;
use std::fs;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = File::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.files().insert(req)
             .visibility("duo")
             .use_content_as_indexable_text(true)
             .timed_text_track_name("ut")
             .timed_text_language("rebum.")
             .supports_team_drives(false)
             .supports_all_drives(true)
             .pinned(false)
             .ocr_language("tempor")
             .ocr(false)
             .include_permissions_for_view("Lorem")
             .enforce_single_parent(true)
             .convert(true)
             .upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).await;

Implementations

impl<'a> FileInsertCall<'a>[src]

pub async fn upload_resumable<RS>(
    self,
    resumeable_stream: RS,
    mime_type: Mime
) -> Result<(Response<Body>, File)> where
    RS: ReadSeek
[src]

Upload media in a resumable fashion. Even if the upload fails or is interrupted, it can be resumed for a certain amount of time as the server maintains state temporarily.

The delegate will be asked for an upload_url(), and if not provided, will be asked to store an upload URL that was provided by the server, using store_upload_url(...). The upload will be done in chunks, the delegate may specify the chunk_size() and may cancel the operation before each chunk is uploaded, using cancel_chunk_upload(...).

  • multipart: yes
  • max size: 5120GB
  • valid mime types: ‘/

pub async fn upload<RS>(
    self,
    stream: RS,
    mime_type: Mime
) -> Result<(Response<Body>, File)> where
    RS: ReadSeek
[src]

Upload media all at once. If the upload fails for whichever reason, all progress is lost.

  • multipart: yes
  • max size: 5120GB
  • valid mime types: ‘/

pub fn request(self, new_value: File) -> FileInsertCall<'a>[src]

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn visibility(self, new_value: &str) -> FileInsertCall<'a>[src]

The visibility of the new file. This parameter is only relevant when convert=false.

Sets the visibility query property to the given value.

pub fn use_content_as_indexable_text(
    self,
    new_value: bool
) -> FileInsertCall<'a>
[src]

Whether to use the content as indexable text.

Sets the use content as indexable text query property to the given value.

pub fn timed_text_track_name(self, new_value: &str) -> FileInsertCall<'a>[src]

The timed text track name.

Sets the timed text track name query property to the given value.

pub fn timed_text_language(self, new_value: &str) -> FileInsertCall<'a>[src]

The language of the timed text.

Sets the timed text language query property to the given value.

pub fn supports_team_drives(self, new_value: bool) -> FileInsertCall<'a>[src]

Deprecated use supportsAllDrives instead.

Sets the supports team drives query property to the given value.

pub fn supports_all_drives(self, new_value: bool) -> FileInsertCall<'a>[src]

Whether the requesting application supports both My Drives and shared drives.

Sets the supports all drives query property to the given value.

pub fn pinned(self, new_value: bool) -> FileInsertCall<'a>[src]

Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.

Sets the pinned query property to the given value.

pub fn ocr_language(self, new_value: &str) -> FileInsertCall<'a>[src]

If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

Sets the ocr language query property to the given value.

pub fn ocr(self, new_value: bool) -> FileInsertCall<'a>[src]

Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

Sets the ocr query property to the given value.

pub fn include_permissions_for_view(self, new_value: &str) -> FileInsertCall<'a>[src]

Specifies which additional view’s permissions to include in the response. Only ‘published’ is supported.

Sets the include permissions for view query property to the given value.

pub fn enforce_single_parent(self, new_value: bool) -> FileInsertCall<'a>[src]

Deprecated. Creating files in multiple folders is no longer supported.

Sets the enforce single parent query property to the given value.

pub fn convert(self, new_value: bool) -> FileInsertCall<'a>[src]

Whether to convert this file to the corresponding Docs Editors format.

Sets the convert query property to the given value.

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileInsertCall<'a>[src]

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

pub fn param<T>(self, name: T, value: T) -> FileInsertCall<'a> where
    T: AsRef<str>, 
[src]

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

  • alt (query-string) - Data format for the response.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token (query-string) - OAuth 2.0 token for the current user.
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
  • userIp (query-string) - Deprecated. Please use quotaUser instead.

pub fn add_scope<T, S>(self, scope: T) -> FileInsertCall<'a> where
    T: Into<Option<S>>,
    S: AsRef<str>, 
[src]

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::Full.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.

Trait Implementations

Auto Trait Implementations

impl<'a> !RefUnwindSafe for FileInsertCall<'a>

impl<'a> Send for FileInsertCall<'a>

impl<'a> !Sync for FileInsertCall<'a>

impl<'a> Unpin for FileInsertCall<'a>

impl<'a> !UnwindSafe for FileInsertCall<'a>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.