Skip to main content

FileSystemLimits

Struct FileSystemLimits 

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

Stable limits declared by a configured filesystem provider.

§Examples

use qubit_fs::metadata::{FileSystemLimit, FileSystemLimits};

let limits = FileSystemLimits::unknown();
assert_eq!(FileSystemLimit::Unknown, limits.max_path_text_bytes());

Implementations§

Source§

impl FileSystemLimits

Source

pub const fn unknown() -> Self

Creates a limit snapshot whose dimensions are all explicitly unknown.

Source

pub const fn with_max_path_text_bytes(self, limit: FileSystemLimit) -> Self

Returns a copy with the path-text byte limit replaced by limit.

Source

pub const fn with_max_component_text_bytes(self, limit: FileSystemLimit) -> Self

Returns a copy with the component-text byte limit replaced by limit.

Source

pub const fn with_max_read_range_bytes(self, limit: FileSystemLimit) -> Self

Returns a copy with the range-read byte limit replaced by limit.

Source

pub const fn with_max_write_bytes(self, limit: FileSystemLimit) -> Self

Returns a copy with the write-session byte limit replaced by limit.

Source

pub const fn with_max_list_page_entries(self, limit: FileSystemLimit) -> Self

Returns a copy with the native list-page entry limit replaced by limit.

Source

pub const fn max_path_text_bytes(&self) -> FileSystemLimit

Returns the maximum canonical crate::path::Path text length in UTF-8 bytes.

Source

pub const fn max_component_text_bytes(&self) -> FileSystemLimit

Returns the maximum path-component text length in UTF-8 bytes.

Source

pub const fn max_read_range_bytes(&self) -> FileSystemLimit

Returns the maximum byte count accepted by one logical range read.

Source

pub const fn max_write_bytes(&self) -> FileSystemLimit

Returns the maximum total byte count accepted by one write session.

Source

pub const fn max_list_page_entries(&self) -> FileSystemLimit

Returns the maximum entry count in one provider-native list page.

Source

pub fn clamp_list_page_size(&self, requested: Option<usize>) -> Option<usize>

Clamps a requested list-page size to the declared finite maximum.

Unknown, unbounded, and inapplicable limits leave the hint unchanged. A missing hint remains absent so the provider can select its natural page size while still honoring its declared limit.

§Parameters
  • requested: Optional caller-supplied page-size hint.
§Returns

The effective page-size hint forwarded to the provider.

Source

pub fn validate_path( &self, path: &Path, semantics: PathSemantics, operation: FsOperation, ) -> FsResult<()>

Validates a canonical filesystem path against provider path limits.

Component limits are checked only for hierarchical path semantics.

§Errors

Returns FsErrorKind::ResourceLimitExceeded when the complete path text or a hierarchical component exceeds its declared finite maximum.

Source

pub fn validate_read_range( &self, path: &Path, length: Option<u64>, ) -> FsResult<()>

Validates a requested logical range-read length.

A missing length cannot be preflighted and remains the provider’s responsibility during execution.

§Errors

Returns FsErrorKind::ResourceLimitExceeded when length exceeds the declared finite range-read maximum.

Source

pub fn validate_write_size(&self, path: &Path, bytes: usize) -> FsResult<()>

Validates the total bytes supplied to one write session.

§Errors

Returns FsErrorKind::ResourceLimitExceeded when bytes exceeds the declared finite write-session maximum.

Trait Implementations§

Source§

impl Clone for FileSystemLimits

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FileSystemLimits

Source§

impl Debug for FileSystemLimits

Source§

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

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

impl Eq for FileSystemLimits

Source§

impl PartialEq for FileSystemLimits

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FileSystemLimits

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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.