Permissions

Struct Permissions 

Source
pub struct Permissions { /* private fields */ }
Expand description

Permissions for a file.

A permission grants a user, group, domain, or the world access to a file or a folder hierarchy.

Some resource methods (such as permissions.update) require a permission_id. Use the permissions.list method to retrieve the ID for a file, folder, or shared drive.

§Examples:

List the permission in a file

let file_id = "some-file-id";
let permission_list = drive.permissions.list(&file_id).execute()?;

if let Some(permissions) = permission_list.permissions {
    for permission in permissions {
        println!("{}", permission);
    }
}

Implementations§

Source§

impl Permissions

Source

pub fn new(credentials: &Credentials) -> Self

Creates a new Permissions resource with the given Credentials.

Source

pub fn create<T: AsRef<str>>(&self, file_id: T) -> CreateRequest

Creates a permission for a file or shared drive.

See Google’s documentation for more information.

§Warning

Concurrent permissions operations on the same file are not supported; only the last update is applied.

§Requires one of the following OAuth scopes:
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
§Examples:
use drive_v3::objects::Permission;

let permission = Permission {
    permission_type: Some( "anyone".to_string() ),
    role: Some( "reader".to_string() ),
    ..Default::default()
};

let file_id = "some-file-id";

let created_permission = drive.permissions.create(&file_id)
    .permission(&permission)
    .execute()?;

assert_eq!(created_permission.permission_type, permission.permission_type);
assert_eq!(created_permission.role, permission.role);
Source

pub fn delete<T, U>(&self, file_id: T, permission_id: U) -> DeleteRequest
where T: AsRef<str>, U: AsRef<str>,

Deletes a permission.

See Google’s documentation for more information.

§Warning

Concurrent permissions operations on the same file are not supported; only the last update is applied.

§Requires one of the following OAuth scopes:
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
§Examples:
let file_id = "some-file-id";
let permission_id = "some-permission-id";

let response = drive.permissions.delete(&file_id, &permission_id).execute();

assert!( response.is_ok() );
Source

pub fn get<T, U>(&self, file_id: T, permission_id: U) -> GetRequest
where T: AsRef<str>, U: AsRef<str>,

Gets a permission by ID.

See Google’s documentation for more information.

§Requires one of the following OAuth scopes:
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly
§Examples:
let file_id = "some-file-id";
let permission_id = "some-permission-id";

let permission = drive.permissions.get(&file_id, &permission_id).execute()?;

println!("This is the file's permission:\n{}", permission);
Source

pub fn list<T: AsRef<str>>(&self, file_id: T) -> ListRequest

Lists a file’s or shared drive’s permissions.

See Google’s documentation for more information.

§Requires one of the following OAuth scopes:
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly
§Examples:
let file_id = "some-file-id";
let permission_list = drive.permissions.list(&file_id).execute()?;

if let Some(permissions) = permission_list.permissions {
    for permission in permissions {
        println!("{}", permission);
    }
}
Source

pub fn update<T, U>(&self, file_id: T, permission_id: U) -> UpdateRequest
where T: AsRef<str>, U: AsRef<str>,

Updates a permission with patch semantics.

See Google’s documentation for more information.

§Warning

Concurrent permissions operations on the same file are not supported; only the last update is applied.

§Requires one of the following OAuth scopes:
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
§Examples:
use drive_v3::objects::Permission;

let updated_permission = Permission {
    permission_type: Some( "anyone".to_string() ),
    role: Some( "commenter".to_string() ),
    ..Default::default()
};

let file_id = "some-file-id";
let permission_id = "some-permission-id";

let permission = drive.permissions.update(&file_id, &permission_id)
    .permission(&updated_permission)
    .execute()?;

assert_eq!(permission.permission_type, updated_permission.permission_type);
assert_eq!(permission.role, updated_permission.role);

Trait Implementations§

Source§

impl Clone for Permissions

Source§

fn clone(&self) -> Permissions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Permissions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Permissions

Source§

fn eq(&self, other: &Permissions) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Permissions

Source§

impl StructuralPartialEq for Permissions

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<U> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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