Struct PqcMetadata 

pub struct PqcMetadata {
    pub kem_params: Option<KemParameters>,
    pub sig_params: Option<SigParameters>,
    pub enc_params: EncParameters,
    pub compression_params: Option<CompressionParameters>,
    pub custom: HashMap<String, Vec<u8>>,
}

Algorithm-specific metadata container

Contains all parameters needed to decrypt and verify the encrypted data.

Fields

kem_params: Option<KemParameters>

Key encapsulation parameters (optional)

sig_params: Option<SigParameters>

Signature parameters (optional)

enc_params: EncParameters

Encryption parameters (required)

compression_params: Option<CompressionParameters>

Compression parameters (optional)

custom: HashMap<String, Vec<u8>>

Additional custom parameters

Implementations

impl PqcMetadata

pub fn new() -> Self

Create new empty metadata with default encryption parameters

Example

use pqc_binary_format::PqcMetadata;

let mut metadata = PqcMetadata::new();
metadata.enc_params.iv = vec![0; 12];
metadata.enc_params.tag = vec![0; 16];

pub fn validate(&self) -> Result<()>

Validate metadata structure

Ensures all required fields are present and valid.

pub fn add_custom(&mut self, key: String, value: Vec<u8>)

Add custom parameter

Example

use pqc_binary_format::PqcMetadata;

let mut metadata = PqcMetadata::new();
metadata.add_custom("my_param".to_string(), vec![1, 2, 3]);

pub fn get_custom(&self, key: &str) -> Option<&[u8]>

Get custom parameter

Example

use pqc_binary_format::PqcMetadata;

let mut metadata = PqcMetadata::new();
metadata.add_custom("my_param".to_string(), vec![1, 2, 3]);
assert_eq!(metadata.get_custom("my_param"), Some(&[1, 2, 3][..]));

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

Serialize the metadata to the canonical UTF-8 JSON object used in the metadata section of the binary format (Section 5 of the specification).

Byte-valued fields (IV, tag, public keys, ciphertext, signature, custom values) are base64-encoded so the section stays valid UTF-8. Object keys serialize in sorted order (serde_json’s map is a BTreeMap), giving a deterministic encoding suitable for the integrity checksum.

pub fn from_json_bytes(bytes: &[u8]) -> Result<Self>

Reconstruct metadata from the canonical JSON object produced by PqcMetadata::to_json_bytes.

Errors

Returns CryptoError::MetadataError if the bytes are not valid UTF-8 JSON, the required encryption_params object is missing, or any base64-encoded field cannot be decoded.

Trait Implementations

impl Clone for PqcMetadata

fn clone(&self) -> PqcMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PqcMetadata

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

Formats the value using the given formatter.

impl Default for PqcMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PqcMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PqcMetadata

impl PartialEq for PqcMetadata

fn eq(&self, other: &PqcMetadata) -> 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 Serialize for PqcMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PqcMetadata