Struct TempDirectory 

pub struct TempDirectory { /* private fields */ }

Temporary directory retaining the provider session until lifecycle completion.

Examples

use qubit_fs::temp::{TempOptions, TempResourceState};

let mut temporary = filesystem.create_temp_directory(TempOptions::default())?;
assert_eq!(TempResourceState::Owned, temporary.state());

Implementations

impl TempDirectory

pub const fn path(&self) -> &Path

Returns the logical temporary directory path.

pub const fn state(&self) -> TempResourceState

Returns the resource lifecycle state.

pub fn child(&self, component: &PathComponent) -> Path

Returns one lexically safe child path.

pub fn descendant(&self, relative: &RelativePath) -> Path

Returns one lexically safe descendant path.

pub fn persist( &mut self, target: &Path, options: PersistOptions, ) -> Result<PersistOutcome, PersistFailure>

Persists this directory.

Parameters

• target: Destination path validated by the owning filesystem.
• options: Atomicity and publication requirements.

Returns

The provider-confirmed publication outcome.

Errors

Returns a typed failure for invalid lifecycle state, failed preflight, provider failure, or a provider contract violation.

pub fn keep(&mut self) -> Result<PersistOutcome, PersistFailure>

Publishes this temporary directory to the provider-generated target.

Returns

The provider-confirmed publication outcome and generated target.

Errors

Returns a typed failure when ownership is unavailable, provider publication fails, or the provider returns an invalid target.

pub fn cleanup(&mut self) -> FsResult<()>

Cleans the temporary directory.

Errors

Returns an invalid-state error when cleanup is no longer legal, or the provider cleanup error when cleanup cannot be confirmed.

Trait Implementations

impl Debug for TempDirectory

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

Formats the value using the given formatter.

impl Drop for TempDirectory

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.