Struct FileEncryptionProperties

pub struct FileEncryptionProperties { /* private fields */ }

Defines how data in a Parquet file should be encrypted

The FileEncryptionProperties should be included in the WriterProperties used to write a file by using WriterPropertiesBuilder::with_file_encryption_properties.

Examples

Create FileEncryptionProperties for a file encrypted with uniform encryption, where all metadata and data are encrypted with the footer key:

let file_encryption_properties = FileEncryptionProperties::builder(b"0123456789012345".into())
    .build()?;

Create properties for a file where columns are encrypted with different keys. Any columns without a key specified will be unencrypted:

let file_encryption_properties = FileEncryptionProperties::builder(b"0123456789012345".into())
    .with_column_key("x", b"1234567890123450".into())
    .with_column_key("y", b"1234567890123451".into())
    .build()?;

Specify additional authenticated data, used to protect against data replacement. This should represent the file identity:

let file_encryption_properties = FileEncryptionProperties::builder(b"0123456789012345".into())
    .with_aad_prefix("example_file".into())
    .build()?;

Implementations

impl FileEncryptionProperties

pub fn builder(footer_key: Vec<u8>) -> EncryptionPropertiesBuilder

Create a new builder for encryption properties with the given footer encryption key

pub fn encrypt_footer(&self) -> bool

Should the footer be encrypted

pub fn footer_key_metadata(&self) -> Option<&Vec<u8>>

Retrieval metadata of key used for encryption of footer and (possibly) columns

pub fn footer_key(&self) -> &Vec<u8>

Retrieval of key used for encryption of footer and (possibly) columns

pub fn column_keys(&self) -> (Vec<String>, Vec<Vec<u8>>, Vec<Vec<u8>>)

Get the column names, keys, and metadata for columns to be encrypted

pub fn aad_prefix(&self) -> Option<&Vec<u8>>

AAD prefix string uniquely identifies the file and prevents file swapping

pub fn store_aad_prefix(&self) -> bool

Should the AAD prefix be stored in the file

Trait Implementations

impl Clone for FileEncryptionProperties

fn clone(&self) -> FileEncryptionProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileEncryptionProperties

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

Formats the value using the given formatter.

impl From<&FileEncryptionProperties> for ConfigFileEncryptionProperties

fn from(f: &FileEncryptionProperties) -> ConfigFileEncryptionProperties

Converts to this type from the input type.

impl From<ConfigFileEncryptionProperties> for FileEncryptionProperties

fn from(val: ConfigFileEncryptionProperties) -> FileEncryptionProperties

Converts to this type from the input type.

impl PartialEq for FileEncryptionProperties

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FileEncryptionProperties