Struct lock_keeper::crypto::Encryptor

pub struct Encryptor {
    data: Vec<u8>,
    context: CryptorContext,
    config: SensitiveInfoConfig,
}

The Encryptor type. It contains data to be encrypted, plus context and config fields.

Fields

data: Vec<u8>

The actual bytes of data to be encrypted.

context: CryptorContext

Additional context about the data.

config: SensitiveInfoConfig

Configuration

Implementations

impl Encryptor

pub fn new( data: Vec<u8>, context: CryptorContext, config: SensitiveInfoConfig ) -> Self

Constructs a new instance of Encryptor type.

Arguments

• data - A vector of bytes representing the data to be managed by the instance.

• context - An instance of CryptorContext that provides necessary cryptographic context for operations that may be performed on data.

• config - A SensitiveInfoConfig instance that provides configuration details for managing sensitive information.

Returns

• Returns a new instance of Encryptor type, initialized with the provided data, context, and config.

Example

let data = vec![1, 2, 3, 4, 5];
let context = CryptorContext::new(...);
let config = SensitiveInfoConfig::new(true);

let encryptor = Encryptor::new(data, context, config);

pub fn data(&self) -> &[u8]

Returns a reference to the encrypted data bytes stored within the Encryptor instance.

This method provides read-only access to the internal data field, ensuring that the encrypted data cannot be modified directly by the caller.

Examples

// Assuming you've set up an `Encryptor` instance named `encryptor`
let data_bytes: &[u8] = encryptor.data();

Returns

A byte slice (&[u8]) that represents the encrypted data. Returns a reference to the data bytes.

pub fn encrypt( self, rng: &mut (impl CryptoRng + RngCore), encryption_key: &CryptorKey ) -> Result<Decryptor, CryptoError>

Encrypts data using the provided encryption key.

Arguments

• rng - A mutable reference to the random number generator.
• encryption_key - The key used to encrypt data.

Returns

• A new instance of the Encryptor
• Returns an error of type [CryptoError] if the encryption process fails.

Trait Implementations

impl Clone for Encryptor

fn clone(&self) -> Encryptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encryptor

An implementation of the std::fmt::Debug trait for Encryptor

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

Formats the value using the given formatter.

impl Display for Encryptor

An implementation of the std::fmt::Display trait for Encryptor

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

Formats the value using the given formatter.

impl Drop for Encryptor

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Encryptor

Implement the PartialEq trait for the Encryptor type.

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

Determines if two Encryptor instances are equal.

This function compares the data and context fields of two Encryptor instances. It does not compare the config fields because the config field does not affect the functional equivalence of two Encryptor instances.

Arguments

• other - The other Encryptor instance to compare with.

Returns

Returns true if the data and context fields are equal between the two Encryptor instances, Otherwise returns false.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Encryptor> for Vec<u8>

Implementation of the TryFrom trait for converting to Vec<u8>

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(encryptor: Encryptor) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Encryptor

Implementation of the TryFrom trait for converting from Vec<u8> to Encryptor

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Encryptor