Struct Shutdown 

pub struct Shutdown { /* private fields */ }

A shared shutdown signal for coordinating graceful termination.

use photon_ring::Shutdown;

let shutdown = Shutdown::new();
let flag = shutdown.clone();

// In consumer thread:
// while !flag.is_shutdown() {
//     match sub.try_recv() {
//         Ok(v) => { /* process */ }
//         Err(_) => core::hint::spin_loop(),
//     }
// }

// In main thread:
shutdown.trigger();
assert!(flag.is_shutdown());

Implementations

impl Shutdown

pub fn new() -> Self

Create a new shutdown signal (not yet triggered).

pub fn trigger(&self)

Trigger the shutdown signal. All clones will observe is_shutdown() == true.

pub fn is_shutdown(&self) -> bool

Returns true if trigger has been called on any clone.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Shutdown

fn default() -> Self

Returns the “default value” for a type.