#![forbid(unsafe_code)]
mod disk;
mod reader;
pub use disk::{DiskImageInfo, DiskImageReader};
#[cfg(feature = "write")]
mod writer;
pub use reader::{
BackingVolume, ByteCoverage, CheckOutcome, Container, ContainerVerification, DiskImageSet,
IntegrityCheck, Limits, MetadataScan, MetadataVerification, PhysicalDisk, PhysicalDiskReader,
Property, ReaderCacheInfo, ReaderStatistics, ResourceVerification, SetDigest, SetVerification,
SetVolumeVerification, StreamInfo, Verification, VolumeSet, VolumeSource,
};
#[cfg(feature = "write")]
pub use writer::{
AcquiredStream, CaseMetadata, CollectionIssue, CollectionLimits, CollectionOptions,
CollectionReport, Compression, LogicalMetadata, Profile, SubstreamKind, WriteOptions,
WriteResult, Writer,
};
pub type Result<T> = std::result::Result<T, Error>;
#[derive(Debug, thiserror::Error)]
pub enum Error {
#[error("staged AFF4 container verification failed; inspect the retained verification report")]
VerificationFailed {
report: Box<ContainerVerification>,
},
#[error("AFF4 collection limit {resource}: requires {required}, limit {limit}")]
ResourceLimit {
resource: &'static str,
required: u64,
limit: u64,
},
#[error(transparent)]
Io(#[from] std::io::Error),
#[error("AFF4 output published at {path}, but directory synchronization failed: {source}", path = result.path.display())]
#[cfg(feature = "write")]
PublishedButUnsynced {
result: Box<WriteResult>,
#[source]
source: std::io::Error,
},
#[error(transparent)]
Zip(#[from] zip::result::ZipError),
#[error("malformed AFF4: {0}")]
Malformed(String),
#[error("unsupported AFF4: {0}")]
Unsupported(String),
#[error("operation cancelled")]
Aborted,
}
pub(crate) fn malformed(message: impl Into<String>) -> Error {
Error::Malformed(message.into())
}