Struct Ctl

pub struct Ctl { /* private fields */ }

Ctl is a handle to the kstat library.

Users instantiate a control handle and access the kstat’s it contains, for example via the Ctl::iter method.

Implementations

impl Ctl

pub fn new() -> Result<Self, Error>

Create a new Ctl.

pub fn update(self) -> Result<Self, Error>

Synchronize this Ctl with the kernel’s view of the data.

A Ctl is really a snapshot of the kernel’s internal list of kstats. This method consumes and updates a control object, bringing it into sync with the kernel’s copy.

pub fn iter(&self) -> Iter<'_>

Return an iterator over the Kstats in self.

Note that this will only return Kstats which are successfully read. For example, it will ignore those with non-UTF-8 names.

pub fn read<'a>(&self, kstat: &mut Kstat<'a>) -> Result<Data<'a>, Error>

Read a Kstat, returning the data for it.

pub fn filter<'a>( &'a self, module: Option<&'a str>, instance: Option<i32>, name: Option<&'a str>, ) -> impl Iterator<Item = Kstat<'a>>

Find Kstats by module, instance, and/or name.

If a field is None, any matching Kstat is returned.

Trait Implementations

impl Debug for Ctl

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

Formats the value using the given formatter.

impl Drop for Ctl

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Ctl

The Ctl wraps a raw pointer allocated by the libkstat(3KSTAT) library. This itself isn’t thread-safe, but doesn’t refer to any thread-local state. So it’s safe to send across threads.