pub struct DeferredCleanup { /* private fields */ }Expand description
Deferred extraction-root cleanup paired with outstanding bound sources.
Returned by BoundExtraction::into_members. Run this only after bound
handles are consumed or closed; cleanup empties the owned root solely via
the retained handle, never by traversing a pathname.
Implementations§
Source§impl DeferredCleanup
impl DeferredCleanup
Sourcepub fn root(&self) -> &Path
pub fn root(&self) -> &Path
Returns the retained private extraction root for residue diagnostics.
Sourcepub fn cleanup(self) -> Result<(), ExtractionError>
pub fn cleanup(self) -> Result<(), ExtractionError>
Empties the owned extraction root through the retained root handle.
The crate empties the owned tree through the retained directory handle. It never removes the root directory itself and never traverses the root pathname, so a foreign directory, file, symlink, or reparse point installed at the recorded pathname is never touched.
§Contract
Okmeans the owned root object held no entries at the final handle-relative listing: the owned tree was emptied.ErrwithExtractionErrorKind::CleanupFailedmeans the owned root could not be fully emptied. The residue may be partially emptied, its emptiness is not guaranteed, andExtractionError::residue_pathnames the recorded root path.
The residual directory is the caller’s to remove: this crate never
removes it and offers no convenience that removes it by pathname.
Because this call consumes the value, capture the residual path from
root before calling it.
The recorded root path is advisory: if the root was renamed or replaced by a third party, the crate emptied the owned object and left whatever occupies the recorded pathname untouched.