Enum sysctl::Ctl

pub enum Ctl {
    Oid(Vec<c_int>),
    Name(String, CtlType, String),
}

This struct represents a system control.

Variants

Oid(Vec<c_int>)

Name(String, CtlType, String)

Implementations

impl Ctl

pub fn oid(&self) -> Option<&Vec<c_int>>

Trait Implementations

impl Clone for Ctl

fn clone(&self) -> Ctl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ctl

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

Formats the value using the given formatter.

impl FromStr for Ctl

type Err = SysctlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoIterator for Ctl

Ctl implements the IntoIterator trait to allow for easy iteration over nodes.

Example

use sysctl::Sysctl;

let kern = sysctl::Ctl::new("kern");
for ctl in kern {
    println!("{}", ctl.name().unwrap());
}

type Item = Result<Ctl, SysctlError>

The type of the elements being iterated over.

type IntoIter = CtlIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Ctl

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sysctl for Ctl

fn new(name: &str) -> Result<Self, SysctlError>

Construct a Ctl from the name.

fn new_with_type( name: &str, _ctl_type: CtlType, _fmt: &str ) -> Result<Self, SysctlError>

Construct a Ctl from the name, type and format.

fn name(&self) -> Result<String, SysctlError>

Returns a result containing the sysctl name on success, or a SysctlError on failure.

fn value_type(&self) -> Result<CtlType, SysctlError>

Returns a result containing the sysctl value type on success, or a Sysctl Error on failure.

fn description(&self) -> Result<String, SysctlError>

Returns a result containing the sysctl description if success, or an Error on failure.

fn value(&self) -> Result<CtlValue, SysctlError>

Returns a result containing the sysctl value on success, or a SysctlError on failure.

fn value_as<T>(&self) -> Result<Box<T>, SysctlError>

A generic method that takes returns a result containing the sysctl value if success, or a SysctlError on failure.

fn value_string(&self) -> Result<String, SysctlError>

Returns a result containing the sysctl value as String on success, or a SysctlError on failure.

fn set_value(&self, value: CtlValue) -> Result<CtlValue, SysctlError>

Sets the value of a sysctl. Fetches and returns the new value if successful, or returns a SysctlError on failure.

fn set_value_string(&self, value: &str) -> Result<String, SysctlError>

Sets the value of a sysctl with input as string. Fetches and returns the new value if successful, or returns a SysctlError on failure.

fn flags(&self) -> Result<CtlFlags, SysctlError>

Get the flags for a sysctl.

fn info(&self) -> Result<CtlInfo, SysctlError>

Returns a Result containing the control metadata for a sysctl.

impl StructuralPartialEq for Ctl