SpillFile

Struct SpillFile 

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

A handle to a temporary spill file

The file is automatically deleted when this handle is dropped. Files are created lazily - no disk I/O occurs until the first write.

§Example

use vibesql_executor::memory::SpillFile;
use std::path::Path;

let mut file = SpillFile::new(Path::new("/tmp/vibesql"))?;

// Write sorted run
file.write_all(&serialized_data)?;
file.flush()?;

// Read back
file.seek(SeekFrom::Start(0))?;
let data = file.read_to_vec()?;

// File is automatically deleted when `file` is dropped

Implementations§

Source§

impl SpillFile

Source

pub fn new(temp_dir: &Path) -> Result<Self>

Create a new spill file in the specified directory

The file is not actually created until the first write.

Source

pub fn with_suffix(temp_dir: &Path, suffix: &str) -> Result<Self>

Create a spill file with a specific name suffix

Useful for debugging - creates files like “vibesql_spill_12345_0_sort_run.tmp”

Source

pub fn path(&self) -> &Path

Get the path to the spill file

Source

pub fn bytes_written(&self) -> usize

Get the number of bytes written to this file

Source

pub fn is_created(&self) -> bool

Check if the file has been created on disk

Source

pub fn write_all(&mut self, data: &[u8]) -> Result<()>

Write data to the spill file

Source

pub fn flush(&mut self) -> Result<()>

Flush buffered data to disk

Source

pub fn prepare_for_read(&mut self) -> Result<()>

Prepare the file for reading

This flushes any pending writes and switches to read mode.

Source

pub fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to a position in the file

Source

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Read data from the spill file

Source

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read exact number of bytes

Source

pub fn read_to_vec(&mut self) -> Result<Vec<u8>>

Read entire file into a Vec

Trait Implementations§

Source§

impl Drop for SpillFile

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

Source§

fn is_within(&self, b: &G2) -> bool

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,