Enum AggregateHashPolicy 

pub enum AggregateHashPolicy {
    Auto,
    None,
    Header,
    Footer,
    Both,
}

Where to place the aggregate hash frame inside a message.

The frame holds every per-object xxh3 digest as hex-encoded text; it is a redundant copy of the per-frame inline hash slots that makes integrity checks possible without walking the body. The per-frame inline slots are always authoritative — the aggregate frame is a convenience for legacy tooling.

Mode constraints

• Buffered encode (encode) accepts every variant.
• Streaming encode (crate::streaming::StreamingEncoder) accepts Auto, None, Footer. Header and Both are rejected at construction time with a clear error: header frames are written before any data object, so the hashes are not yet known.

Auto is the right choice for almost every caller — the encoder picks the mode-appropriate placement.

Variants

Auto

Encoder picks: buffered → Header, streaming → Footer. This is the default and is valid in every mode.

None

No aggregate hash frame is emitted. Per-frame inline hash slots are unaffected.

Header

Emit a HeaderHash frame. Buffered mode only; rejected at construction in streaming mode.

Footer

Emit a FooterHash frame. Valid in both modes.

Both

Emit BOTH a HeaderHash and a FooterHash frame, carrying identical hash lists. Buffered mode only; rejected at construction in streaming mode.

Trait Implementations

impl Clone for AggregateHashPolicy

fn clone(&self) -> AggregateHashPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AggregateHashPolicy

impl Debug for AggregateHashPolicy

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

Formats the value using the given formatter.

impl Default for AggregateHashPolicy

fn default() -> AggregateHashPolicy

Returns the “default value” for a type.

impl Eq for AggregateHashPolicy

impl PartialEq for AggregateHashPolicy

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