[−][src]Trait sysctl::Sysctl

pub trait Sysctl {
    fn new(name: &str) -> Result<Self, SysctlError>
    where
        Self: Sized;
    fn name(&self) -> Result<String, SysctlError>;
    fn value_type(&self) -> Result<CtlType, SysctlError>;
    fn description(&self) -> Result<String, SysctlError>;
    fn value(&self) -> Result<CtlValue, SysctlError>;
    fn value_as<T>(&self) -> Result<Box<T>, SysctlError>;
    fn value_string(&self) -> Result<String, SysctlError>;
    fn set_value(&self, value: CtlValue) -> Result<CtlValue, SysctlError>;
    fn set_value_string(&self, value: &str) -> Result<String, SysctlError>;
    fn flags(&self) -> Result<CtlFlags, SysctlError>;
    fn info(&self) -> Result<CtlInfo, SysctlError>;
}

Required methods

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

Construct a Ctl from the name.

Returns a result containing the struct Ctl on success or a SysctlError on failure.

Example

let ctl = sysctl::Ctl::new("kern.ostype");

If the sysctl does not exist, Err(SysctlError::NotFound) is returned.

let ctl = sysctl::Ctl::new("this.sysctl.does.not.exist");
match ctl {
    Err(sysctl::SysctlError::NotFound(_)) => (),
    Err(e) => panic!(format!("Wrong error type returned: {:?}", e)),
    Ok(_) => panic!("Nonexistent sysctl seems to exist"),
}

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

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

Example

let ctl = sysctl::Ctl::new("kern.ostype").unwrap();
assert_eq!(ctl.name().unwrap(), "kern.ostype");

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

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

Example

let ctl = sysctl::Ctl::new("kern.ostype").unwrap();
let value_type = ctl.value_type().unwrap();
assert_eq!(value_type, sysctl::CtlType::String);

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

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

Example

let ctl = sysctl::Ctl::new("kern.ostype").unwrap();
println!("Description: {:?}", ctl.description())

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

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

Example

let ctl = sysctl::Ctl::new("kern.ostype").unwrap();
println!("Value: {:?}", ctl.value());

`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.

May only be called for sysctls of type Opaque or Struct.

Example

#[derive(Debug)]
#[repr(C)]
struct ClockInfo {
    hz: libc::c_int, /* clock frequency */
    tick: libc::c_int, /* micro-seconds per hz tick */
    spare: libc::c_int,
    stathz: libc::c_int, /* statistics clock frequency */
    profhz: libc::c_int, /* profiling clock frequency */
}

let ctl = sysctl::Ctl::new("kern.clockrate").unwrap();
println!("{:?}", ctl.value_as::<ClockInfo>());

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

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

Example

let ctl = sysctl::Ctl::new("kern.osrevision").unwrap();
println!("Value: {}", ctl.value_string());

`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.

Example

extern crate sysctl;
extern crate libc;
use sysctl::Sysctl;

fn main() {
    if unsafe { libc::getuid() } == 0 {
        let ctl = sysctl::Ctl::new("hw.usb.debug").unwrap();
        let org = ctl.value().unwrap();
        let set = ctl.set_value(sysctl::CtlValue::Int(1)).unwrap();
        assert_eq!(set, sysctl::CtlValue::Int(1));
        ctl.set_value(original).unwrap();
    }
}

`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.

Example

extern crate sysctl;
use sysctl::Sysctl;

fn main() {
    let ctl = sysctl::Ctl::new("hw.usb.debug").unwrap();
    let org = ctl.value_string().unwrap();
    let set = ctl.set_value_string("1");
    println!("hw.usb.debug: -> {:?}", set);
    ctl.set_value_string(&org).unwrap();
}

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

Get the flags for a sysctl.

Returns a Result containing the flags on success, or a SysctlError on failure.

Example

let ctl = sysctl::Ctl::new("kern.ostype").unwrap();
let readable = ctl.flags().unwrap().contains(sysctl::CtlFlags::RD);
assert!(readable);

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

Returns a Result containing the control metadata for a sysctl.

Returns a Result containing the CtlInfo struct on success, or a SysctlError on failure.

Example

extern crate sysctl;
use sysctl::Sysctl;

fn main() {
    let ctl = Ctl::new("kern.osrevision").unwrap();
    let info = ctl.info().unwrap();

    // kern.osrevision is not a structure.
    assert_eq!(info.struct_type(), None);
}