Struct TempDryIceFile 

pub struct TempDryIceFile { /* private fields */ }

An owned temporary dryice file that evaporates by default.

TempDryIceFile owns a filesystem path created by dryice. The file is removed when cleanup is called, or on drop as a best-effort fallback. Use persist to move the file into a caller-owned location and disable automatic cleanup.

Implementations

impl TempDryIceFile

pub fn new() -> Result<Self, DryIceError>

Create a temporary dryice file in the system temporary directory.

Errors

Returns an error if a temporary file cannot be created.

pub fn new_in<P: AsRef<Path>>(directory: P) -> Result<Self, DryIceError>

Create a temporary dryice file in directory.

The directory must already exist. The file is created with exclusive creation semantics to avoid reusing an existing path.

Errors

Returns an error if the directory does not exist, if permissions prevent file creation, or if a unique temporary path cannot be created after repeated attempts.

pub fn path(&self) -> &Path

Return the owned temporary file path.

pub fn open(&self) -> Result<File, DryIceError>

Open the owned temporary file for reading and writing.

The returned File is a normal Rust file handle. It can be passed into DryIceWriter, returned by writer.finish(), rewound, and then passed into DryIceReader:

use std::io::{Seek, SeekFrom};

use dryice::{DryIceWriter, SeqRecord, TempDryIceFile};

let temp = TempDryIceFile::new()?;
let file = temp.open()?;
let mut writer = DryIceWriter::builder().inner(file).build();
let record = SeqRecord::new(b"r1".to_vec(), b"ACGT".to_vec(), b"!!!!".to_vec())?;
writer.write_record(&record)?;
let mut file = writer.finish()?;
file.seek(SeekFrom::Start(0))?;
temp.cleanup()?;

Errors

Returns an error if the temporary file cannot be opened.

pub fn cleanup(self) -> Result<(), DryIceError>

Remove the temporary file now.

Missing files are treated as already cleaned up. If the file has already been persisted, cleanup is a no-op because dryice no longer owns the file lifecycle.

Errors

Returns an error if removing the temporary file fails for reasons other than the file already being absent.

pub fn persist<P: AsRef<Path>>( &mut self, path: P, ) -> Result<PathBuf, DryIceError>

Move the temporary file into a caller-owned path.

After a successful persist, dryice no longer owns the file lifecycle and will not remove the destination on drop. The destination must not already exist.

Errors

Returns an error if path already exists or if the temporary file cannot be renamed to path.

Trait Implementations

impl Drop for TempDryIceFile

fn drop(&mut self)

Executes the destructor for this type.