Enum Note 

#[non_exhaustive]
pub enum Note {
    UnparsedRegion {
        location: String,
        bytes: u64,
    },
    IncrementalHistory {
        revisions: usize,
    },
    OrphanedObjectsRemoved {
        objects: usize,
    },
    OutOfScopeContent {
        location: String,
    },
    FilenameMayIdentify,
    CapabilityRemoved {
        location: String,
        capability: String,
    },
}

A caveat about what strypt did or could not do.

Modelled as an enum rather than free text so that front-ends can present notes consistently, and so that a limitation cannot be introduced by a handler quietly writing a new sentence. Notes are how the tool stays honest about partial knowledge without either hiding a limitation or failing outright.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnparsedRegion

The file contained a region the handler could not parse. Its bytes were preserved as-is, so metadata inside it — if any — was not removed.

Fields

location: String

The region’s format-domain identifier.

bytes: u64

How many bytes were left untouched.

IncrementalHistory

The file had been saved incrementally, so earlier revisions were present in it.

Fields

revisions: usize

How many prior revisions were found.

OrphanedObjectsRemoved

Objects that nothing in the finished document referred to any more were dropped.

Usually the remains of superseded revisions. They are worth reporting because their presence tells the user something true about the file they were about to publish: earlier drafts of it were physically inside it.

Fields

objects: usize

How many unreachable objects were dropped.

OutOfScopeContent

Content was found that strypt deliberately does not touch, such as text drawn under a redaction rectangle (docs/THREAT_MODEL.md §4.3).

Fields

location: String

What was seen.

FilenameMayIdentify

The filename itself may identify its subject. A scrubbed file called IMG_survivor_address.jpg is not scrubbed in any meaningful sense (docs/ARCHITECTURE.md §8).

CapabilityRemoved

Removing metadata cost the file something it could previously do — not what it renders, but what it can still be used for. JPEG XL’s jbrd box is the case the variant exists for: it holds the original JPEG’s marker segments, so it goes, and bit-exact JPEG reconstruction goes with it (ADR-0036).

Fields

location: String

What was removed.

capability: String

What the file can no longer do, phrased to follow “this file can no longer”.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Eq for Note

impl PartialEq for Note

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Note