Skip to main content

FsLimits

Struct FsLimits 

Source
pub struct FsLimits {
    pub max_total_bytes: u64,
    pub max_file_size: u64,
    pub max_file_count: u64,
}
Expand description

Filesystem resource limits.

Controls maximum resource consumption for in-memory filesystems. Applied to both InMemoryFs and OverlayFs.

§Example

use bashkit::{Bash, FsLimits, InMemoryFs};
use std::sync::Arc;

// Create filesystem with custom limits
let limits = FsLimits::new()
    .max_total_bytes(50_000_000)  // 50MB total
    .max_file_size(5_000_000)     // 5MB per file
    .max_file_count(1000);        // 1000 files max

let fs = Arc::new(InMemoryFs::with_limits(limits));
let bash = Bash::builder().fs(fs).build();

§Default Limits

LimitDefaultPurpose
max_total_bytes100MBTotal filesystem memory
max_file_size10MBSingle file size
max_file_count10,000Number of files

Fields§

§max_total_bytes: u64

Maximum total bytes across all files. Default: 100MB (100,000,000 bytes)

§max_file_size: u64

Maximum size of a single file in bytes. Default: 10MB (10,000,000 bytes)

§max_file_count: u64

Maximum number of files (not including directories). Default: 10,000

Implementations§

Source§

impl FsLimits

Source

pub fn new() -> Self

Create new limits with defaults.

§Example
use bashkit::FsLimits;

let limits = FsLimits::new();
assert_eq!(limits.max_total_bytes, 100_000_000);
Source

pub fn unlimited() -> Self

Create unlimited limits (no restrictions).

§Warning

Using unlimited limits removes protection against memory exhaustion. Only use in trusted environments.

§Example
use bashkit::FsLimits;

let limits = FsLimits::unlimited();
assert_eq!(limits.max_total_bytes, u64::MAX);
Source

pub fn max_total_bytes(self, bytes: u64) -> Self

Set maximum total filesystem size.

§Example
use bashkit::FsLimits;

let limits = FsLimits::new().max_total_bytes(50_000_000); // 50MB
Source

pub fn max_file_size(self, bytes: u64) -> Self

Set maximum single file size.

§Example
use bashkit::FsLimits;

let limits = FsLimits::new().max_file_size(1_000_000); // 1MB
Source

pub fn max_file_count(self, count: u64) -> Self

Set maximum file count.

§Example
use bashkit::FsLimits;

let limits = FsLimits::new().max_file_count(100);
Source

pub fn check_total_bytes( &self, current: u64, additional: u64, ) -> Result<(), FsLimitExceeded>

Check if adding bytes would exceed total limit.

Returns Ok(()) if within limits, Err(FsLimitExceeded) otherwise.

Source

pub fn check_file_size(&self, size: u64) -> Result<(), FsLimitExceeded>

Check if a file size exceeds the limit.

Source

pub fn check_file_count(&self, current: u64) -> Result<(), FsLimitExceeded>

Check if adding a file would exceed the count limit.

Trait Implementations§

Source§

impl Clone for FsLimits

Source§

fn clone(&self) -> FsLimits

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FsLimits

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FsLimits

Source§

fn default() -> Self

Returns the “default value” for a 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.