[−][src]Struct ironoxide::document::DocumentEncryptOpts
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]
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
[src]
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 documentgrants
- 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]
id: Option<DocumentId>,
name: Option<DocumentName>,
policy: PolicyGrant
) -> DocumentEncryptOpts
Trait Implementations
impl Clone for DocumentEncryptOpts
[src]
pub fn clone(&self) -> DocumentEncryptOpts
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for DocumentEncryptOpts
[src]
impl Default for DocumentEncryptOpts
[src]
pub 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 Eq for DocumentEncryptOpts
[src]
impl Hash for DocumentEncryptOpts
[src]
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<DocumentEncryptOpts> for DocumentEncryptOpts
[src]
pub fn eq(&self, other: &DocumentEncryptOpts) -> bool
[src]
pub fn ne(&self, other: &DocumentEncryptOpts) -> bool
[src]
impl StructuralEq for DocumentEncryptOpts
[src]
impl StructuralPartialEq for DocumentEncryptOpts
[src]
Auto Trait Implementations
impl RefUnwindSafe for DocumentEncryptOpts
[src]
impl Send for DocumentEncryptOpts
[src]
impl Sync for DocumentEncryptOpts
[src]
impl Unpin for DocumentEncryptOpts
[src]
impl UnwindSafe for DocumentEncryptOpts
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Clear for T where
T: InitializableFromZeroed + ?Sized,
T: InitializableFromZeroed + ?Sized,
pub fn clear(&mut self)
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
[src]
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> InitializableFromZeroed for T where
T: Default,
T: Default,
pub unsafe fn initialize(place: *mut T)
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
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]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,