Struct ironoxide::document::DocumentEncryptOpts

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

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

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

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

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

fn clone(&self) -> DocumentEncryptOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentEncryptOpts

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

Formats the value using the given formatter.

impl Default for DocumentEncryptOpts

fn default() -> Self

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<DocumentEncryptOpts> for DocumentEncryptOpts

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

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

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

This method tests for !=.

impl Eq for DocumentEncryptOpts

impl StructuralEq for DocumentEncryptOpts

impl StructuralPartialEq for DocumentEncryptOpts