TempDir

Struct TempDir 

Source
pub struct TempDir { /* private fields */ }
Expand description

A temporary directory that automatically cleans up when dropped.

This struct provides RAII (Resource Acquisition Is Initialization) semantics for temporary directories. The directory is created when the struct is created and automatically removed when the struct is dropped, even if the program panics.

§Examples

use agpm_cli::utils::fs::TempDir;

{
    let temp = TempDir::new("test")?;
    let temp_path = temp.path();
     
    // Use the temporary directory
    std::fs::write(temp_path.join("file.txt"), "temporary data")?;
     
    // Directory exists here
    assert!(temp_path.exists());
} // TempDir is dropped here, directory is automatically cleaned up

§Thread Safety

Each TempDir instance creates a unique directory using UUID generation, making it safe to use across multiple threads without naming conflicts.

§Cleanup Behavior

  • Directory is removed recursively when dropped
  • Cleanup happens even if the program panics
  • If cleanup fails (rare), the error is silently ignored
  • Uses the system temporary directory as the parent

§Use Cases

  • Unit testing with temporary files
  • Staging areas for atomic operations
  • Scratch space for temporary processing

Implementations§

Source§

impl TempDir

Source

pub fn new(prefix: &str) -> Result<Self>

Creates a new temporary directory with the given prefix.

The directory is created immediately and will have a name like agpm_{prefix}_{uuid} in the system temporary directory.

§Arguments
  • prefix - A prefix for the directory name (for identification)
§Returns

A new TempDir instance, or an error if directory creation fails

§Examples
use agpm_cli::utils::fs::TempDir;

let temp = TempDir::new("cache")?;
println!("Temporary directory: {}", temp.path().display());
Source

pub fn path(&self) -> &Path

Returns the path to the temporary directory.

The directory is guaranteed to exist as long as this TempDir instance exists.

§Returns

A reference to the temporary directory path

Trait Implementations§

Source§

impl Drop for TempDir

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,