stuffr_core/
lib.rs

1//! Core abstractions for the `stuffr` toolkit.
2//!
3//! This crate deliberately depends on **no** compression format crate. That
4//! constraint is what makes the stream ladder and the thread governor testable
5//! against mock formats, with no C toolchain and no real archives.
6
7pub mod archive;
8#[cfg(feature = "testing")]
9pub mod conformance;
10#[cfg(feature = "testing")]
11mod container_conformance;
12pub mod containment;
13mod display;
14pub mod error;
15pub mod fidelity;
16pub mod format;
17pub mod governor;
18#[cfg(any(test, feature = "testing"))]
19mod honesty;
20pub mod ladder;
21pub mod probe;
22pub mod registry;
23pub mod salvage;
24pub mod size;
25pub mod source;
26#[cfg(any(test, feature = "testing"))]
27pub mod testing;
28
29pub use archive::{
30    ArchiveRead, ArchiveWrite, Codec, Container, CreateOpts, DecodeOpts, EncodeOpts, Entry,
31    EntryKind, EntryMeta, OpenOpts, PlainSink, Sink,
32};
33pub use containment::{
34    NameRefusal, SymlinkVerdict, check_symlink_target, classify_symlink_target,
35    name_refused_by_filesystem, safe_join,
36};
37pub use display::fmt_name;
38pub use error::{Error, Result};
39pub use fidelity::{Fidelity, FidelityReport, MetaFields, Rung};
40pub use format::{
41    CodecCaps, ContainerCaps, CorruptionDetection, FormatId, FormatKind, FormatMeta, MagicRule,
42};
43pub use governor::{BudgetInputs, Governor, LeaseSet, default_memory_limit, resolve_workers};
44pub use ladder::{Resolved, StreamPolicy, resolve};
45pub use probe::{
46    Chain, PROBE_LEN, chain_for_new_path, probe, resolve_chain, resolve_chain_deep,
47    resolve_chain_deep_with,
48};
49pub use registry::{FormatRow, Registry};
50pub use size::format_size;
51pub use source::{
52    Counting, CountingWriter, DEFAULT_MAX_RATIO, FileSource, PeekSource, RATIO_FLOOR, RatioGuard,
53    ReaderSource, SeekRead, Source, SourceCaps, SpillPolicy, SpillSource, SpillWriter, StreamOnly,
54};
55
56pub const VERSION: &str = env!("CARGO_PKG_VERSION");
stuffr_core/lib.rs

stuffr_core/
lib.rs
