Struct DiskSpaceGuard 

pub struct DiskSpaceGuard { /* private fields */ }

Thread-safe disk space guard for monitoring and enforcing disk limits.

Implementations

impl DiskSpaceGuard

pub fn new(config: DiskSpaceGuardConfig) -> Self

Create a new disk space guard with the given configuration.

pub fn default_guard() -> Self

Create a disk space guard with default configuration.

pub fn with_min_free(min_free_mb: usize) -> Self

Create a disk space guard with specified minimum free space.

pub fn shared(config: DiskSpaceGuardConfig) -> Arc<Self>

Create an Arc-wrapped disk space guard for sharing across threads.

pub fn check(&self) -> Result<(), DiskSpaceExhausted>

Check disk space limit (returns error if hard limit exceeded).

This should be called periodically during file writes. It’s designed to be efficient - actual disk checks only happen at the configured interval.

pub fn check_now(&self) -> Result<(), DiskSpaceExhausted>

Force an immediate disk space check (bypasses interval).

pub fn check_before_write( &self, estimated_bytes: u64, ) -> Result<(), DiskSpaceExhausted>

Pre-check if there’s enough space for an estimated write.

pub fn record_write(&self, bytes: u64)

Record bytes written (for estimation).

pub fn stats(&self) -> DiskStats

Get current disk space statistics.

pub fn available_space_mb(&self) -> usize

Get current available space in MB.

pub fn is_available() -> bool

Check if disk space tracking is available on this platform.

pub fn reset_stats(&self)

Reset statistics (for testing).

Trait Implementations

impl Debug for DiskSpaceGuard

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

Formats the value using the given formatter.

impl Default for DiskSpaceGuard

fn default() -> Self

Returns the “default value” for a type.