Struct OpenedArchive 

pub struct OpenedArchive {
    pub volume_header: VolumeHeader,
    pub crypto_header: CryptoHeaderFixed,
    pub manifest_footer: ManifestFooter,
    pub volume_trailer: Option<VolumeTrailer>,
    pub root_auth_footer: Option<RootAuthFooterV1>,
    pub index_root: IndexRoot,
    /* private fields */
}

Fields

volume_header: VolumeHeader

crypto_header: CryptoHeaderFixed

manifest_footer: ManifestFooter

volume_trailer: Option<VolumeTrailer>

root_auth_footer: Option<RootAuthFooterV1>

index_root: IndexRoot

Implementations

impl OpenedArchive

pub fn open_with_options( bytes: &[u8], master_key: &MasterKey, options: ReaderOptions, ) -> Result<Self, FormatError>

pub fn open_with_recipient_wrap_resolver_options<F>( bytes: &[u8], resolver: F, options: ReaderOptions, ) -> Result<Self, FormatError>

where F: FnMut(RecipientWrapRecordContext<'_>) -> Result<Vec<RecipientWrapCandidateMasterKey>, FormatError>,

pub fn open_seekable_with_recipient_wrap_resolver_options<R, F>( reader: R, resolver: F, options: ReaderOptions, ) -> Result<Self, FormatError>

where R: ArchiveReadAt, F: FnMut(RecipientWrapRecordContext<'_>) -> Result<Vec<RecipientWrapCandidateMasterKey>, FormatError>,

pub fn open_seekable_volumes_with_recipient_wrap_resolver_options<R, F>( readers: Vec<R>, resolver: F, options: ReaderOptions, ) -> Result<Self, FormatError>

where R: ArchiveReadAt, F: FnMut(RecipientWrapRecordContext<'_>) -> Result<Vec<RecipientWrapCandidateMasterKey>, FormatError>,

pub fn open_volumes_with_options( volumes: &[&[u8]], master_key: &MasterKey, options: ReaderOptions, ) -> Result<Self, FormatError>

pub fn open_seekable_volumes_with_options<R: ArchiveReadAt>( readers: Vec<R>, master_key: &MasterKey, options: ReaderOptions, ) -> Result<Self, FormatError>

pub fn open_with_bootstrap_sidecar_options( bytes: &[u8], bootstrap_sidecar: &[u8], master_key: &MasterKey, options: ReaderOptions, ) -> Result<Self, FormatError>

pub fn list_index_entries(&self) -> Result<Vec<ArchiveIndexEntry>, FormatError>

Return path and payload-size entries from encrypted index metadata only.

Unlike Self::list_files, this does not decode tar member groups, so it does not read or decrypt payload envelopes after the index shards are available.

pub fn lookup_index_entry( &self, path: &str, ) -> Result<Option<ArchiveIndexEntry>, FormatError>

Look up one archive path using encrypted index metadata only.

pub fn list_files(&self) -> Result<Vec<ArchiveEntry>, FormatError>

pub fn extract_file(&self, path: &str) -> Result<Option<Vec<u8>>, FormatError>

Return only the regular-file payload bytes for path.

This is a payload-only convenience for callers that do not need tar metadata fidelity diagnostics. Use Self::extract_file_with_diagnostics or Self::extract_member when unsupported local PAX/GNU metadata must be reported to users.

pub fn extract_file_with_diagnostics( &self, path: &str, ) -> Result<Option<ExtractedRegularFile>, FormatError>

Return regular-file payload bytes together with parsed tar metadata diagnostics for path.

pub fn extract_file_to_writer<W: Write>( &self, path: &str, writer: &mut W, ) -> Result<Option<Vec<MetadataDiagnostic>>, ExtractError>

Stream regular-file payload bytes for path into writer.

This keeps extraction memory bounded by the selected payload envelope, one decompressed frame, and small tar metadata buffers. It returns the same metadata diagnostics as Self::extract_file_with_diagnostics.

pub fn extract_file_to_writer_with_progress<W: Write>( &self, path: &str, writer: &mut W, progress: &mut dyn ArchiveExtractProgressSink, ) -> Result<Option<Vec<MetadataDiagnostic>>, ExtractError>

Stream regular-file payload bytes for path into writer while reporting extracted logical payload bytes.

pub fn extract_member( &self, path: &str, ) -> Result<Option<ExtractedArchiveMember>, FormatError>

pub fn extract_file_to( &self, path: &str, root: &Path, options: SafeExtractionOptions, ) -> Result<Option<Vec<MetadataDiagnostic>>, FormatError>

pub fn extract_indexed_files_to( &self, root: &Path, options: SafeExtractionOptions, jobs: usize, ) -> Result<Vec<(String, Vec<MetadataDiagnostic>)>, FormatError>

pub fn verify(&self) -> Result<(), FormatError>

pub fn verify_content( &self, ) -> Result<ArchiveContentVerification<'_>, FormatError>

pub fn verify_content_fast( &self, ) -> Result<ArchiveContentVerification<'_>, FormatError>

pub fn fast_verify_defers_payload_semantics(&self) -> bool

pub fn repair_patches(&self) -> Result<Vec<ArchiveRepairPatch>, FormatError>

pub fn extract_all_to( &self, root: &Path, options: SafeExtractionOptions, ) -> Result<Vec<(String, Vec<MetadataDiagnostic>)>, FormatError>

pub fn verify_root_auth_with<F>( &self, verifier: F, ) -> Result<RootAuthVerification, FormatError>

where F: FnMut(&RootAuthFooterV1, &[u8; 32]) -> Result<bool, FormatError>,

pub fn verify_root_auth_with_verified_content<F>( &self, content_verification: &ArchiveContentVerification<'_>, verifier: F, ) -> Result<RootAuthVerification, FormatError>

where F: FnMut(&RootAuthFooterV1, &[u8; 32]) -> Result<bool, FormatError>,

Trait Implementations

impl Clone for OpenedArchive

fn clone(&self) -> OpenedArchive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenedArchive

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

Formats the value using the given formatter.