Struct SizeLimit 

pub struct SizeLimit(/* private fields */);

A byte limit that is either absent or a positive number of bytes up to MAX_FILE_SIZE_LIMIT.

The TOML spelling of “unlimited” is 0; it exists only at that edge, so no consumer re-checks for it. Deserializes from an integer and rejects an out-of-range value at load time.

Examples

use mcpls_core::config::SizeLimit;

let limit = SizeLimit::new(100).unwrap();
assert!(limit.admits(100));
assert!(!limit.admits(101));
assert!(SizeLimit::UNLIMITED.admits(u64::MAX));
assert_eq!(SizeLimit::new(0).unwrap(), SizeLimit::UNLIMITED);
assert!(SizeLimit::new(u64::MAX).is_err());

Implementations

impl SizeLimit

pub const UNLIMITED: Self

No limit.

pub const fn new(bytes: u64) -> Result<Self, InvalidSizeLimit>

A limit of bytes, where 0 means unlimited.

Errors

Returns InvalidSizeLimit above MAX_FILE_SIZE_LIMIT.

pub const fn from_static(bytes: u64) -> Self

A limit from a literal, checked at compile time when evaluated in a const context.

Panics

Panics if bytes is above MAX_FILE_SIZE_LIMIT.

pub const fn get(self) -> Option<NonZeroU64>

The limit in bytes, or None when unlimited.

pub const fn admits(self, bytes: u64) -> bool

Whether a file of bytes is within the limit.

pub const fn read_cap(self) -> u64

Byte cap for a bounded read: one more than the limit, so a read that reaches the cap is known to have exceeded it, or u64::MAX when unlimited.

impl SizeLimit

pub const DEFAULT: Self

The built-in default, 10 MiB.

Trait Implementations

impl Clone for SizeLimit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SizeLimit

impl Debug for SizeLimit

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

Formats the value using the given formatter.

impl Default for SizeLimit

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SizeLimit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SizeLimit

impl From<SizeLimit> for u64

fn from(value: SizeLimit) -> Self

Converts to this type from the input type.

impl Hash for SizeLimit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SizeLimit

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SizeLimit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SizeLimit

impl TryFrom<u64> for SizeLimit

type Error = InvalidSizeLimit

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.