Struct EncryptedDataBuilder 

pub struct EncryptedDataBuilder { /* private fields */ }

Builder for complete EncryptedData fragments and document replacement.

Implementations

impl EncryptedDataBuilder

pub fn new(algorithm: DataEncryptionAlgorithm) -> Self

Create a builder for a content-encryption algorithm.

pub fn policy(self, policy: EncryptionPolicy) -> Self

Replace the complete immutable encryption policy snapshot.

pub fn chacha_parameters(self, parameters: ChaChaParameters) -> Self

Supply ChaCha wire parameters, not a policy exception. Omit the nonce to generate a fresh one through the selected provider. An explicit nonce must never be reused with the same key across encryption calls.

pub fn provider(self, provider: Arc<dyn CryptoProvider>) -> Self

Select the cryptographic provider for this operation context.

pub fn xml_backend(self, backend: XmlBackend) -> Self

Select the compiled XML parser backend for encryption document work.

pub fn encryption_type(self, encrypted_type: EncryptedDataType) -> Self

Set whether XML encryption covers one element or its child content.

pub fn id(self, id: impl Into<String>) -> Self

Set the generated EncryptedData identifier.

pub fn direct_key(self, key: impl Into<Vec<u8>>) -> Self

Use a caller-managed content key instead of generating and wrapping one.

pub fn encapsulation_key(self, key: Arc<dyn KeyEncapsulationKey>) -> Self

Generate the content key through an experimental KEM recipient handle. The final immutable policy must explicitly permit its parameter set.

pub fn derived_key( self, method: KeyDerivationMethod, secret: impl Into<Vec<u8>>, ) -> Self

Derive the direct content key inside the operation’s key-resolution gate. Parameters and secret are explicit request inputs; the final builder policy controls execution, not the policy used to parse parameters.

pub fn agreement_key( self, method: KeyDerivationMethod, key: Box<dyn KeyAgreementKey>, algorithm: KeyAgreementAlgorithm, peer_public_key: impl Into<Vec<u8>>, ) -> Self

Establish the direct content key through an opaque private-key handle.

The peer is an explicit request input. Agreement and derivation execute through the selected provider only after the final policy has permitted both mechanisms and reserved their operation-wide workspace. For ECDH-ES, supply a freshly generated sender pair. The owned key is consumed at most once, including across builder clones and failed agreement attempts. Export its public role before transferring ownership.

pub fn direct_key_name(self, key_name: impl Into<String>) -> Self

Emit a direct KeyName hint for a caller-managed content key. This names the content key, never an encapsulation recipient key.

pub fn add_recipient(self, recipient: EncryptionRecipient) -> Self

Add one independently wrapped recipient of the generated content key.

pub fn recipient_rsa_oaep(self, public_key: RsaPublicKey) -> Self

Add an RSA-OAEP recipient using secure XMLEnc 1.1 defaults.

pub fn recipient_key_transport( self, public_key: Arc<dyn KeyTransportKey>, ) -> Self

Add an RSA-OAEP recipient backed by an opaque provider key handle.

pub fn recipient_aes_kw( self, kek: impl Into<Vec<u8>>, algorithm: KeyWrapAlgorithm, ) -> Self

Add an AES Key Wrap recipient.

pub fn encrypt_xml(&self, xml: &str) -> Result<EncryptionResult, XmlEncError>

Encrypt one complete XML element or an XML content fragment.

pub fn encrypt_binary( &self, data: &[u8], ) -> Result<EncryptionResult, XmlEncError>

Encrypt opaque bytes, preserving a configured non-XML Type hint.

Element and Content are XML replacement semantics and are omitted from binary output. Any other URI remains application metadata.

pub fn encrypt_document( &self, xml: &str, options: DocumentEncryptionOptions<'_>, ) -> Result<String, XmlEncError>

Encrypt and replace the document root or one element selected by XML ID.

pub fn encrypt_owned_document( &self, document: &mut XmlDocument, options: DocumentEncryptionOptions<'_>, ) -> Result<(), XmlEncError>

Encrypt and replace a node in a reusable owned XML document.

Successful mutation advances the document generation and invalidates identities captured before this call.

Trait Implementations

impl Clone for EncryptedDataBuilder

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 EncryptedDataBuilder

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

Formats the value using the given formatter.