Enum SamplerError 

pub enum SamplerError {
    Load(LoadError),
    Framework(FrameworkError),
    InvalidCpuName,
    UnknownCpu(String),
    EventUnavailable(Event),
    EventLayoutMismatch {
        expected: usize,
        actual: usize,
    },
    UnexpectedNullPointer,
    MissingPrivileges,
    FailedToForceAllCounters(c_int),
    FailedToSetKpcConfig(c_int),
    UnableToStartCounting(c_int),
    UnableToStopCounting(c_int),
    UnableToStartThreadCounting(c_int),
    UnableToStopThreadCounting(c_int),
    UnableToReadCounters(c_int),
    UnableToResetControl(c_int),
    SamplerNotRunning,
}

Available on macOS only.

An error from the Sampler API.

Variants

Load(LoadError)

Failed to load a framework via dlopen/dlsym.

Framework(FrameworkError)

A kperfdata.framework (KPEP) operation failed.

InvalidCpuName

The PMC database name is not valid UTF-8.

UnknownCpu(String)

The detected CPU is not recognized by this build.

EventUnavailable(Event)

An event is not available on the detected CPU.

EventLayoutMismatch

The framework’s kpep_event struct size does not match our definition.

Fields

expected: usize

actual: usize

UnexpectedNullPointer

A framework function returned a null pointer where non-null was expected.

MissingPrivileges

Insufficient privileges to access performance counters.

Run with sudo or sign the binary with the com.apple.private.kernel.kpc entitlement.

FailedToForceAllCounters(c_int)

Failed to force-acquire all hardware counters.

FailedToSetKpcConfig(c_int)

Failed to set KPC register configuration.

UnableToStartCounting(c_int)

Failed to enable counting.

UnableToStopCounting(c_int)

Failed to disable counting.

UnableToStartThreadCounting(c_int)

Failed to enable per-thread counting.

UnableToStopThreadCounting(c_int)

Failed to disable per-thread counting.

UnableToReadCounters(c_int)

Failed to read thread counters.

UnableToResetControl(c_int)

Failed to release force-acquired counters during teardown.

SamplerNotRunning

Attempted to sample while counting is not enabled.

Trait Implementations

impl Debug for SamplerError

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

Formats the value using the given formatter.

impl Display for SamplerError

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

Formats the value using the given formatter.

impl Error for SamplerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<FrameworkError> for SamplerError

fn from(value: FrameworkError) -> Self

Converts to this type from the input type.

impl From<LoadError> for SamplerError

fn from(value: LoadError) -> Self

Converts to this type from the input type.