pub struct ConfigBuilder { /* private fields */ }
Expand description
Configuration for a memory data tracker (builder)
Implementations§
Source§impl ConfigBuilder
impl ConfigBuilder
Sourcepub fn max(&mut self, value: impl Into<ExplicitOrAuto<usize>>) -> &mut Self
pub fn max(&mut self, value: impl Into<ExplicitOrAuto<usize>>) -> &mut Self
Maximum memory usage tolerated before reclamation starts
Setting this to usize::MAX
disables the memory quota.
The default is “auto”, which uses a value derived from the total system memory. It should not be assumed that the value used for “auto” will remain stable across different versions of this library.
Note that this is not a hard limit. See Approximate in the overview.
(Setter method.)
Sourcepub fn low_water(
&mut self,
value: impl Into<ExplicitOrAuto<usize>>,
) -> &mut Self
pub fn low_water( &mut self, value: impl Into<ExplicitOrAuto<usize>>, ) -> &mut Self
Reclamation will stop when memory use is reduced to below this value
Default is “auto”, which uses 75% of the maximum. It should not be assumed that the value used for “auto” will remain stable across different versions of this library.
If set to an explicit value,
then max
must be set to an explicit value as well.
(Setter method.)
Source§impl ConfigBuilder
impl ConfigBuilder
Sourcepub fn build(&self) -> Result<Config, ConfigBuildError>
pub fn build(&self) -> Result<Config, ConfigBuildError>
Builds a new Config
from a builder
Returns an error if the fields values are invalid or inconsistent.
Trait Implementations§
Source§impl Clone for ConfigBuilder
impl Clone for ConfigBuilder
Source§fn clone(&self) -> ConfigBuilder
fn clone(&self) -> ConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ConfigBuilder
impl Debug for ConfigBuilder
Source§impl Default for ConfigBuilder
impl Default for ConfigBuilder
Source§fn default() -> ConfigBuilder
fn default() -> ConfigBuilder
Source§impl<'de> Deserialize<'de> for ConfigBuilder
impl<'de> Deserialize<'de> for ConfigBuilder
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Flattenable for ConfigBuilder
impl Flattenable for ConfigBuilder
Source§impl PartialEq for ConfigBuilder
impl PartialEq for ConfigBuilder
Source§impl Serialize for ConfigBuilder
impl Serialize for ConfigBuilder
impl Eq for ConfigBuilder
impl StructuralPartialEq for ConfigBuilder
Auto Trait Implementations§
impl Freeze for ConfigBuilder
impl RefUnwindSafe for ConfigBuilder
impl Send for ConfigBuilder
impl Sync for ConfigBuilder
impl Unpin for ConfigBuilder
impl UnwindSafe for ConfigBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more