Struct ironoxide::document::DocumentEncryptOpts[−][src]

pub struct DocumentEncryptOpts { /* fields omitted */ }

Parameters that can be provided when encrypting a new document.

Document IDs must be unique to the segment. If no ID is provided, one will be generated for it. If no name is provided, the document’s name will be left empty. Neither the document’s ID nor name will be encrypted.

Default values are provided with DocumentEncryptOpts::default().

Implementations

impl DocumentEncryptOpts[src]

pub fn new(
    id: Option<DocumentId>,
    name: Option<DocumentName>,
    grants: EitherOrBoth<ExplicitGrant, PolicyGrant>
) -> DocumentEncryptOpts[src]

Constructs a new DocumentEncryptOpts.

Document encryption requires an ExplicitGrant, a PolicyGrant, or both. If only using one type of grant, consider using with_explicit_grants or with_policy_grants instead.

Arguments

  • id - ID to use for the document.
  • name - Name to use for the document.
  • grants - Grants that control who will have access to read and decrypt this document.

pub fn with_explicit_grants(
    id: Option<DocumentId>,
    name: Option<DocumentName>,
    grant_to_author: bool,
    grants: Vec<UserOrGroup>
) -> DocumentEncryptOpts[src]

Constructs a new DocumentEncryptOpts with access explicitly granted to certain users and groups.

Arguments

  • id - ID to use for the document.
  • name - Name to use for the document.
  • grant_to_author - true if the calling user should have access to decrypt the document
  • grants - List of users and groups that should have access to read and decrypt this document

pub fn with_policy_grants(
    id: Option<DocumentId>,
    name: Option<DocumentName>,
    policy: PolicyGrant
) -> DocumentEncryptOpts[src]

Constructs a new DocumentEncryptOpts with access granted by a policy.

Arguments

  • id - ID to use for the document.
  • name - Name to use for the document.
  • policy - Policy to determine which users and groups will have access to read and decrypt this document. See the policy module for more information.

Trait Implementations

impl Clone for DocumentEncryptOpts[src]

fn clone(&self) -> DocumentEncryptOpts[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for DocumentEncryptOpts[src]

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

Formats the value using the given formatter. Read more

impl Default for DocumentEncryptOpts[src]

fn default() -> Self[src]

Constructs a DocumentEncryptOpts with common values.

The document will have a generated ID and no name. Only the document’s author will be able to read and decrypt it.

impl Hash for DocumentEncryptOpts[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<DocumentEncryptOpts> for DocumentEncryptOpts[src]

fn eq(&self, other: &DocumentEncryptOpts) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &DocumentEncryptOpts) -> bool[src]

This method tests for !=.

impl Eq for DocumentEncryptOpts[src]

impl StructuralEq for DocumentEncryptOpts[src]

impl StructuralPartialEq for DocumentEncryptOpts[src]

Auto Trait Implementations

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Clear for T where
    T: InitializableFromZeroed + ?Sized, 

pub fn clear(&mut self)

Completely overwrites this value.

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

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

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

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> InitializableFromZeroed for T where
    T: Default, 

pub unsafe fn initialize(place: *mut T)

Called to initialize a place to a valid value, after it is set to all-bits-zero. Read more

impl<T> Instrument for T[src]

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

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

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.

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

Performs the conversion.

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.

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

Performs the conversion.

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

pub fn vzip(self) -> V