Skip to main content

GuardStopHandle

Struct GuardStopHandle 

Source
pub struct GuardStopHandle { /* private fields */ }
Expand description

Cloneable, thread-safe handle for stopping a running guard loop.

Obtain via GuardRunner::stop_handle() before calling GuardRunner::run(). Can be sent to another thread, stored in a signal handler, or used from an async runtime to request graceful shutdown.

§Example

use std::time::Duration;
use sysprims_proc::{
    GuardRunnerConfig, GuardRunner, GuardConfig, GuardRule, GuardAction,
    CpuMode,
};

let config = GuardRunnerConfig {
    guard: GuardConfig {
        rule: GuardRule {
            root_pid: 12345,
            max_levels: u32::MAX,
            filter: None,
            cpu_mode: CpuMode::Lifetime,
            sample_duration: None,
        },
        action: GuardAction::KillDescendants { signal: 15, cascade: false },
        action_enabled: false,
        max_targets: 8,
    },
    interval: Duration::from_secs(5),
    max_iterations: None,
};

let mut runner = GuardRunner::new(config).unwrap();
let handle = runner.stop_handle();

// Stop from another thread after 30 seconds
std::thread::spawn(move || {
    std::thread::sleep(Duration::from_secs(30));
    handle.stop();
});

let summary = runner.run(|event| {
    println!("matched={}", event.matched);
}, |_tick, err| {
    eprintln!("error: {err}");
}).unwrap();
// summary.stop_reason == StopReason::Requested

Implementations§

Source§

impl GuardStopHandle

Source

pub fn stop(&self)

Request the guard loop to stop gracefully.

The loop will finish the current tick and then exit with StopReason::Requested.

Trait Implementations§

Source§

impl Clone for GuardStopHandle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GuardStopHandle

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.