Struct RefCountedTempFile 

pub struct RefCountedTempFile { /* private fields */ }

A wrapper around a NamedTempFile that also contains a reference to its parent temporary directory.

This type is Clone-able, allowing multiple references to the same underlying file. The file is deleted only when the last reference is dropped.

The parent temporary directory is also kept alive as long as any reference to this file exists, preventing premature cleanup of the directory.

Once all references to this file are dropped, the file is deleted, and the disk usage is subtracted from the disk manager’s total.

Implementations

impl RefCountedTempFile

pub fn path(&self) -> &Path

pub fn inner(&self) -> &NamedTempFile

Trait Implementations

impl Clone for RefCountedTempFile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefCountedTempFile

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

Formats the value using the given formatter.

impl Drop for RefCountedTempFile

When the temporary file is dropped, subtract its disk usage from the disk manager’s total

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.

impl SpillFile for RefCountedTempFile

fn path(&self) -> Option<&Path>

Returns the OS path if this is a local file, None otherwise.

fn size(&self) -> Option<u64>

Returns current size in bytes if cheaply available.

fn read_stream( &self, ) -> Result<Pin<Box<dyn Stream<Item = Result<Bytes>> + Send>>>

Returns file contents as an async stream of byte chunks.

fn open_writer(&self) -> Result<Box<dyn SpillWriter>>

Opens a writer for appending data to this file.