Struct tikv_jemalloc_ctl::background_thread[][src]

pub struct background_thread;

State of internal background worker threads.

When enabled, background threads are created on demand (the number of background threads will be no more than the number of CPUs or active arenas). Threads run periodically and handle purging asynchronously.

use tikv_jemalloc_ctl::background_thread;
let bg = background_thread::mib().unwrap();
let s = bg.read().unwrap();
println!("background_threads enabled: {}", s);
let p = background_thread::update(!s).unwrap();
println!("background_threads enabled: {} => {}", p, bg.read().unwrap());
assert_eq!(p, s);
background_thread::write(s).unwrap();
println!("background_threads enabled: {}", bg.read().unwrap());
assert_eq!(p, s);

Implementations

impl background_thread[src]

pub fn mib() -> Result<background_thread_mib>[src]

Returns Management Information Base (MIB)

This value can be used to access the key without doing string lookup.

pub fn name() -> &'static Name[src]

Key [::keys::Name].

impl background_thread[src]

pub fn read() -> Result<bool>[src]

Reads value using string API.

impl background_thread[src]

pub fn write(value: bool) -> Result<()>[src]

Writes value using string API.

impl background_thread[src]

pub fn update(value: bool) -> Result<bool>[src]

Updates key to value returning its old value using string API.

Auto Trait Implementations

impl Send for background_thread

impl Sync for background_thread

impl Unpin for background_thread

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.