Struct DocumentLimit 

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

A count limit that is either absent or a positive number of documents.

The TOML spelling of “unlimited” is 0; it exists only at that edge.

Examples

use mcpls_core::config::DocumentLimit;

assert_eq!(DocumentLimit::default().get().unwrap().get(), 100);
assert_eq!(DocumentLimit::new(0), DocumentLimit::UNLIMITED);
assert!(DocumentLimit::UNLIMITED.get().is_none());

Implementations

impl DocumentLimit

pub const UNLIMITED: Self

No limit.

pub const fn new(count: usize) -> Self

A limit of count documents, where 0 means unlimited.

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

The limit, or None when unlimited.

impl DocumentLimit

pub const DEFAULT: Self

The built-in default, 100 documents.

Trait Implementations

impl Clone for DocumentLimit

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 DocumentLimit

impl Debug for DocumentLimit

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

Formats the value using the given formatter.

impl Default for DocumentLimit

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentLimit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentLimit

impl From<DocumentLimit> for usize

fn from(value: DocumentLimit) -> Self

Converts to this type from the input type.

impl From<usize> for DocumentLimit

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for DocumentLimit

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 DocumentLimit

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentLimit

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 DocumentLimit