pub struct Permissions(/* private fields */);
Implementations§
Source§impl Permissions
impl Permissions
Sourcepub const PRINTABLE: Permissions
pub const PRINTABLE: Permissions
(Security handlers of revision 2) Print the document.
(Security handlers of revision 3 or greater) Print the document (possibly not at the
highest quality level, depending on whether Permissions::PRINTABLE_IN_HIGH_QUALITY
is also set).
Sourcepub const MODIFIABLE: Permissions
pub const MODIFIABLE: Permissions
Modify the contents of the document by operations other than those controlled by
Permissions::ANNOTABLE
, Permissions::FILLABLE
and Permissions::ASSEMBLABLE
.
Sourcepub const COPYABLE: Permissions
pub const COPYABLE: Permissions
Copy or otherwise extract text and graphics from the document. However, for the limited purpose of providing this content to assistive technology, a PDF reader should behave as if this bit was set to 1.
Sourcepub const ANNOTABLE: Permissions
pub const ANNOTABLE: Permissions
Add or modify text annotations, fill in interactive form fields, and if
Permissions::MODIFIABLE
is also set, create or modify interactive form fields
(including signature fields).
Sourcepub const FILLABLE: Permissions
pub const FILLABLE: Permissions
Fill in existing interactive fields (including signature fields), even if
Permissions::ANNOTABLE
is clear.
Sourcepub const COPYABLE_FOR_ACCESSIBILITY: Permissions
pub const COPYABLE_FOR_ACCESSIBILITY: Permissions
Copy or otherwise extract text and graphics from the document for the purpose of providing this content to assistive technology.
Deprecated since PDF 2.0: must always be set for backward compatibility with PDF viewers following earlier specifications.
Sourcepub const ASSEMBLABLE: Permissions
pub const ASSEMBLABLE: Permissions
(Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or
delete pages and create document outline items or thumbnail images), even if
Permissions::MODIFIABLE
is not set.
Sourcepub const PRINTABLE_IN_HIGH_QUALITY: Permissions
pub const PRINTABLE_IN_HIGH_QUALITY: Permissions
(Security handlers of revision 3 or greater) Print the document to a representation
from which a faithful copy of the PDF content could be generated, based on an
implementation-dependent algorithm. When this bit is clear (and
Permissions::PRINTABLE
is set), printing shall be limited to a low-level
representation of the appearance, possibly of degraded quality.
Source§impl Permissions
impl Permissions
Sourcepub const fn empty() -> Permissions
pub const fn empty() -> Permissions
Get a flags value with all bits unset.
Sourcepub const fn all() -> Permissions
pub const fn all() -> Permissions
Get a flags value with all known bits set.
Sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u64) -> Option<Permissions>
pub const fn from_bits(bits: u64) -> Option<Permissions>
Convert from a bits value.
This method will return None
if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u64) -> Permissions
pub const fn from_bits_truncate(bits: u64) -> Permissions
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u64) -> Permissions
pub const fn from_bits_retain(bits: u64) -> Permissions
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Permissions>
pub fn from_name(name: &str) -> Option<Permissions>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
Sourcepub const fn intersects(&self, other: Permissions) -> bool
pub const fn intersects(&self, other: Permissions) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
Sourcepub const fn contains(&self, other: Permissions) -> bool
pub const fn contains(&self, other: Permissions) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
Sourcepub fn insert(&mut self, other: Permissions)
pub fn insert(&mut self, other: Permissions)
The bitwise or (|
) of the bits in two flags values.
Sourcepub fn remove(&mut self, other: Permissions)
pub fn remove(&mut self, other: Permissions)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
Sourcepub fn toggle(&mut self, other: Permissions)
pub fn toggle(&mut self, other: Permissions)
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub fn set(&mut self, other: Permissions, value: bool)
pub fn set(&mut self, other: Permissions, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
Sourcepub const fn intersection(self, other: Permissions) -> Permissions
pub const fn intersection(self, other: Permissions) -> Permissions
The bitwise and (&
) of the bits in two flags values.
Sourcepub const fn union(self, other: Permissions) -> Permissions
pub const fn union(self, other: Permissions) -> Permissions
The bitwise or (|
) of the bits in two flags values.
Sourcepub const fn difference(self, other: Permissions) -> Permissions
pub const fn difference(self, other: Permissions) -> Permissions
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Sourcepub const fn symmetric_difference(self, other: Permissions) -> Permissions
pub const fn symmetric_difference(self, other: Permissions) -> Permissions
The bitwise exclusive-or (^
) of the bits in two flags values.
Sourcepub const fn complement(self) -> Permissions
pub const fn complement(self) -> Permissions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§impl Permissions
impl Permissions
Sourcepub const fn iter(&self) -> Iter<Permissions>
pub const fn iter(&self) -> Iter<Permissions>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
Sourcepub const fn iter_names(&self) -> IterNames<Permissions>
pub const fn iter_names(&self) -> IterNames<Permissions>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
Source§impl Binary for Permissions
impl Binary for Permissions
Source§impl BitAnd for Permissions
impl BitAnd for Permissions
Source§fn bitand(self, other: Permissions) -> Permissions
fn bitand(self, other: Permissions) -> Permissions
The bitwise and (&
) of the bits in two flags values.
Source§type Output = Permissions
type Output = Permissions
&
operator.Source§impl BitAndAssign for Permissions
impl BitAndAssign for Permissions
Source§fn bitand_assign(&mut self, other: Permissions)
fn bitand_assign(&mut self, other: Permissions)
The bitwise and (&
) of the bits in two flags values.
Source§impl BitOr for Permissions
impl BitOr for Permissions
Source§fn bitor(self, other: Permissions) -> Permissions
fn bitor(self, other: Permissions) -> Permissions
The bitwise or (|
) of the bits in two flags values.
Source§type Output = Permissions
type Output = Permissions
|
operator.Source§impl BitOrAssign for Permissions
impl BitOrAssign for Permissions
Source§fn bitor_assign(&mut self, other: Permissions)
fn bitor_assign(&mut self, other: Permissions)
The bitwise or (|
) of the bits in two flags values.
Source§impl BitXor for Permissions
impl BitXor for Permissions
Source§fn bitxor(self, other: Permissions) -> Permissions
fn bitxor(self, other: Permissions) -> Permissions
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§type Output = Permissions
type Output = Permissions
^
operator.Source§impl BitXorAssign for Permissions
impl BitXorAssign for Permissions
Source§fn bitxor_assign(&mut self, other: Permissions)
fn bitxor_assign(&mut self, other: Permissions)
The bitwise exclusive-or (^
) of the bits in two flags values.
Source§impl Clone for Permissions
impl Clone for Permissions
Source§fn clone(&self) -> Permissions
fn clone(&self) -> Permissions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Permissions
impl Debug for Permissions
Source§impl Default for Permissions
impl Default for Permissions
Source§fn default() -> Permissions
fn default() -> Permissions
Source§impl Extend<Permissions> for Permissions
impl Extend<Permissions> for Permissions
Source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Permissions>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Permissions>,
The bitwise or (|
) of the bits in each flags value.
Source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Source§impl Flags for Permissions
impl Flags for Permissions
Source§const FLAGS: &'static [Flag<Permissions>]
const FLAGS: &'static [Flag<Permissions>]
Source§fn from_bits_retain(bits: u64) -> Permissions
fn from_bits_retain(bits: u64) -> Permissions
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.Source§impl FromIterator<Permissions> for Permissions
impl FromIterator<Permissions> for Permissions
Source§fn from_iter<T>(iterator: T) -> Permissionswhere
T: IntoIterator<Item = Permissions>,
fn from_iter<T>(iterator: T) -> Permissionswhere
T: IntoIterator<Item = Permissions>,
The bitwise or (|
) of the bits in each flags value.
Source§impl Hash for Permissions
impl Hash for Permissions
Source§impl IntoIterator for Permissions
impl IntoIterator for Permissions
Source§type Item = Permissions
type Item = Permissions
Source§type IntoIter = Iter<Permissions>
type IntoIter = Iter<Permissions>
Source§fn into_iter(self) -> <Permissions as IntoIterator>::IntoIter
fn into_iter(self) -> <Permissions as IntoIterator>::IntoIter
Source§impl LowerHex for Permissions
impl LowerHex for Permissions
Source§impl Not for Permissions
impl Not for Permissions
Source§fn not(self) -> Permissions
fn not(self) -> Permissions
The bitwise negation (!
) of the bits in a flags value, truncating the result.
Source§type Output = Permissions
type Output = Permissions
!
operator.Source§impl Octal for Permissions
impl Octal for Permissions
Source§impl Ord for Permissions
impl Ord for Permissions
Source§fn cmp(&self, other: &Permissions) -> Ordering
fn cmp(&self, other: &Permissions) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for Permissions
impl PartialEq for Permissions
Source§impl PartialOrd for Permissions
impl PartialOrd for Permissions
Source§impl Sub for Permissions
impl Sub for Permissions
Source§fn sub(self, other: Permissions) -> Permissions
fn sub(self, other: Permissions) -> Permissions
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§type Output = Permissions
type Output = Permissions
-
operator.Source§impl SubAssign for Permissions
impl SubAssign for Permissions
Source§fn sub_assign(&mut self, other: Permissions)
fn sub_assign(&mut self, other: Permissions)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
Source§impl UpperHex for Permissions
impl UpperHex for Permissions
impl Copy for Permissions
impl Eq for Permissions
impl StructuralPartialEq for Permissions
Auto Trait Implementations§
impl Freeze for Permissions
impl RefUnwindSafe for Permissions
impl Send for Permissions
impl Sync for Permissions
impl Unpin for Permissions
impl UnwindSafe for Permissions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.