Enum rctl::State

pub enum State {
    Disabled,
    Enabled,
    NotPresent,
    Jailed,
}

Enum representing the state of RACCT/RCTL in the kernel.

Variants

Disabled

RCTL / RACCT is present in the kernel, but is not enabled via the kern.racct.enable tunable.

Enabled

RCTL / RACCT is enabled.

NotPresent

RCTL / RACCT is disabled.

The kernel does not support RCTL / RACCT. The following options have to be set in the kernel configuration when compiling the kernel to add support for RCTL / RACCT:

options         RACCT
options         RCTL

Jailed

RCTL is not available within a Jail

Methods

impl State

pub fn check() -> State

Check the state of the RCTL / RACCT support.

This queries the kern.racct.enable sysctl. If this fails in any way, (most probably by the sysctl not being present), the kernel is assumed to be compiled without the RCTL / RACCT options.

Example

let state = rctl::State::check();

pub fn is_enabled(&self) -> bool

Return true if the RCTL / RACCT support is Enabled.

Examples

if rctl::State::check().is_enabled() {
    // do things requiring `RCTL` / `RACCT` support.
}

pub fn is_present(&self) -> bool

Return true if the kernel has RCTL / RACCT support compiled in.

Examples

if ! rctl::State::check().is_present() {
    println!("The kernel does not have RCTL / RACCT support");
}

Trait Implementations

impl Eq for State

impl PartialEq<State> for State

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for State

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for State

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,

Feeds a slice of this type into the given [Hasher].

impl Display for State

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

Formats the value using the given formatter.

impl Debug for State

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

Formats the value using the given formatter.