Struct StcConfig 

pub struct StcConfig { /* private fields */ }

Parameters of one Syndrome-Trellis Codes operation.

Holds key material — the permutation seed — and is therefore wiped on drop. Encode and decode must be given identical configurations: the trellis height is part of the code definition, so a decode at a different height reads a different syndrome and recovers nothing.

Implementations

impl StcConfig

pub fn new(stc_seed: [u8; 32]) -> Self

Builds a configuration around stc_seed, with the defaults of this crate.

There is no constructor that takes a max_bpp. The field exists so the limit can be read, not chosen.

pub fn stc_seed(&self) -> &[u8; 32]

Borrows the permutation seed.

pub fn trellis_height(&self) -> u32

Constraint height of the trellis.

pub fn max_bpp(&self) -> f32

The bits-per-pixel ceiling in force. Always MAX_BPP.

pub fn capacity_bits(&self, positions: usize) -> usize

Bits positions cover elements may carry under the ceiling.

Truncating towards zero, so the limit is never rounded up into a payload that the ceiling does not actually allow. The arithmetic is done in f32 deliberately: crate::stego::sizer advertises capacity with the same expression, and a wider intermediate type here would let a payload pass the sizer and then fail this check.

Trait Implementations

impl Debug for StcConfig

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

Prints the parameters of the configuration, never the seed.

Written by hand rather than derived: a derived implementation would put key material into every log line and error report that formats a config.

impl Drop for StcConfig

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.