Struct FileCopyCall

Source

pub struct FileCopyCall<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

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

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

§Example

Instantiate a resource method builder

use drive3::api::File;

// 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 `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.files().copy(req, "fileId")
             .supports_team_drives(true)
             .supports_all_drives(false)
             .ocr_language("erat")
             .keep_revision_forever(false)
             .include_permissions_for_view("amet")
             .ignore_default_visibility(true)
             .enforce_single_parent(false)
             .doit().await;

Implementations§

Source §

impl<'a, S> FileCopyCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

Source

pub async fn doit(self) -> Result<(Response<Body>, File)>

Perform the operation you have build so far.

Source

pub fn request(self, new_value: File) -> FileCopyCall<'a, S>

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.

Source

pub fn file_id(self, new_value: &str) -> FileCopyCall<'a, S>

The ID of the file.

Sets the file id path property to the given value.

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

Source

pub fn supports_team_drives(self, new_value: bool) -> FileCopyCall<'a, S>

Deprecated use supportsAllDrives instead.

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

Source

pub fn supports_all_drives(self, new_value: bool) -> FileCopyCall<'a, S>

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

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

Source

pub fn ocr_language(self, new_value: &str) -> FileCopyCall<'a, S>

A language hint for OCR processing during image import (ISO 639-1 code).

Sets the ocr language query property to the given value.

Source

pub fn keep_revision_forever(self, new_value: bool) -> FileCopyCall<'a, S>

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.

Sets the keep revision forever query property to the given value.

Source

pub fn include_permissions_for_view( self, new_value: &str, ) -> FileCopyCall<'a, S>

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.

Source

pub fn ignore_default_visibility(self, new_value: bool) -> FileCopyCall<'a, S>

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.

Sets the ignore default visibility query property to the given value.

Source

pub fn enforce_single_parent(self, new_value: bool) -> FileCopyCall<'a, S>

Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.

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

Source

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCopyCall<'a, S>

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.

Source

pub fn param<T>(self, name: T, value: T) -> FileCopyCall<'a, S>
where T: AsRef<str>,

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.

Source

pub fn add_scope<T, St>(self, scope: T) -> FileCopyCall<'a, S>
where T: Into<Option<St>>, St: AsRef<str>,

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§

Source §

impl<'a, S> CallBuilder for FileCopyCall<'a, S>

Auto Trait Implementations§

§

impl<'a, S> !UnwindSafe for FileCopyCall<'a, S>

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

impl<T> WithSubscriber for T

Source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

Struct FileCopyCall Copy item path

§Example

Implementations§

impl<'a, S> FileCopyCall<'a, S>where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

pub async fn doit(self) -> Result<(Response<Body>, File)>

pub fn request(self, new_value: File) -> FileCopyCall<'a, S>

pub fn file_id(self, new_value: &str) -> FileCopyCall<'a, S>

pub fn supports_team_drives(self, new_value: bool) -> FileCopyCall<'a, S>

pub fn supports_all_drives(self, new_value: bool) -> FileCopyCall<'a, S>

pub fn ocr_language(self, new_value: &str) -> FileCopyCall<'a, S>

pub fn keep_revision_forever(self, new_value: bool) -> FileCopyCall<'a, S>

pub fn include_permissions_for_view( self, new_value: &str, ) -> FileCopyCall<'a, S>

pub fn ignore_default_visibility(self, new_value: bool) -> FileCopyCall<'a, S>

pub fn enforce_single_parent(self, new_value: bool) -> FileCopyCall<'a, S>

pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileCopyCall<'a, S>

pub fn param<T>(self, name: T, value: T) -> FileCopyCall<'a, S>where T: AsRef<str>,

§Additional Parameters

pub fn add_scope<T, St>(self, scope: T) -> FileCopyCall<'a, S>where T: Into<Option<St>>, St: AsRef<str>,

Trait Implementations§

impl<'a, S> CallBuilder for FileCopyCall<'a, S>

Auto Trait Implementations§

impl<'a, S> Freeze for FileCopyCall<'a, S>

impl<'a, S> !RefUnwindSafe for FileCopyCall<'a, S>

impl<'a, S> Send for FileCopyCall<'a, S>where S: Sync + Send,

impl<'a, S> !Sync for FileCopyCall<'a, S>

impl<'a, S> Unpin for FileCopyCall<'a, S>

impl<'a, S> !UnwindSafe for FileCopyCall<'a, S>

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> ErasedDestructor for Twhere T: 'static,

Struct FileCopyCall

impl<'a, S> FileCopyCall<'a, S>
where S: Service<Uri> + Clone + Send + Sync + 'static, S::Response: Connection + AsyncRead + AsyncWrite + Send + Unpin + 'static, S::Future: Send + Unpin + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>,

pub fn param<T>(self, name: T, value: T) -> FileCopyCall<'a, S>
where T: AsRef<str>,

pub fn add_scope<T, St>(self, scope: T) -> FileCopyCall<'a, S>
where T: Into<Option<St>>, St: AsRef<str>,

impl<'a, S> Send for FileCopyCall<'a, S>
where S: Sync + Send,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> ErasedDestructor for T
where T: 'static,