Struct Encryption 

#[non_exhaustive]
pub struct Encryption {
    pub user_password: Vec<u8>,
    pub owner_password: Vec<u8>,
    pub permissions: Permissions,
    pub encrypt_metadata: bool,
}

How a document is to be encrypted on save (ISO 32000-2 §7.6.4.4).

#[non_exhaustive]; build one with Encryption::builder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_password: Vec<u8>

Opens the document with the rights permissions grants. Empty means anyone can open it.

owner_password: Vec<u8>

Opens the document with every right. Empty means the user password serves as both.

permissions: Permissions

What a reader who opened with the user password may do.

encrypt_metadata: bool

Whether the document’s XMP metadata stream is enciphered too.

Implementations

impl Encryption

pub fn builder() -> EncryptionBuilder

A builder over the defaults: no passwords, every permission granted, and the metadata stream enciphered with the rest.

use pdfrum_edit::Encryption;

let encryption = Encryption::builder()
    .user_password(b"open-me".to_vec())
    .encrypt_metadata(false)
    .build();

assert_eq!(encryption.user_password, b"open-me");
assert!(!encryption.encrypt_metadata);

Trait Implementations

impl Clone for Encryption

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Encryption

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

Formats the value using the given formatter.

impl Eq for Encryption

impl PartialEq for Encryption

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Encryption