Skip to main content

Crate stegobench_core

Crate stegobench_core 

Source
Expand description

Schemas and the corpus model for stegobench.

This crate holds the formats other people are meant to adopt, and the rules about them that the type system cannot express. Scoring and plugin execution live elsewhere, so that the definition of a result never depends on how a result was obtained.

The IO it does do is reading: a registry of TOML files, a corpus directory on somebody’s disk, and, behind the injected trait boundaries in fetch, a corpus tier being downloaded. There is no network client in here and no default transport; every byte a fetch moves arrives through something the caller passed in.

Re-exports§

pub use corpus::ArchiveFormat;
pub use corpus::CorpusEntry;
pub use corpus::DownloadRoute;
pub use corpus::LicenceStatus;
pub use corpus::Redistribution;
pub use fetch::BlobStore;
pub use fetch::FetchError;
pub use fetch::Fetched;
pub use fetch::FileStore;
pub use fetch::Limits;
pub use fetch::Progress;
pub use fetch::Transport;
pub use header::Format;
pub use header::Geometry;
pub use header::HeaderError;
pub use header::Shape;
pub use manifest::ManifestV1;
pub use manifest::MANIFEST_SCHEMA_ID;
pub use registry::Entry;
pub use registry::Kind;
pub use registry::Registry;
pub use result::Result1;
pub use result::RESULT_SCHEMA_ID;
pub use run::RunV1;
pub use run::RUN_SCHEMA_ID;
pub use samples::Role;
pub use samples::Sample;
pub use samples::SampleError;
pub use samples::Samples;

Modules§

corpus
Corpora as declarative data, beside the tools but not inside them.
exit
Process exit codes, which are part of the CLI’s contract and are documented in the man page. A caller, human or otherwise, distinguishes “I refused” from “I broke”, and an agent that cannot tell them apart retries the refusal.
fetch
Fetching a corpus tier the registry declared a route for, and proving the bytes are the ones it named.
header
Reading what an image says about itself, from its first few bytes.
manifest
manifest-v1: one row per corpus file.
registry
The registry: tools as declarative data rather than as code.
result
result-v1: one measurement, in the form other people are meant to adopt.
run
run-v1: a set of measurements produced together.
samples
Enumerating the scorable items of an unpacked corpus directory.
table
Column alignment for the listings and tables the CLI prints.

Constants§

VERSION
The harness version, stamped into every result so a number can be traced to the code that produced it.