Struct SharedPulse 

pub struct SharedPulse(/* private fields */);

An owned, cloneable pulse that retains planning and cancellation capabilities. The original phase owner alone may finish it. Requires pointer atomics.

A shared view has no completion operation:

use how_far::{Outcome, SharedPulse};
let shared = SharedPulse::default();
shared.finish(Outcome::Succeeded).unwrap();

Implementations

impl SharedPulse

pub fn paced(&self, every: u64) -> Paced<'_>

Checkpoints that reach this shared pulse once every every units; see Paced. One per worker, like any Paced.

impl SharedPulse

pub fn new(pulse: impl Pulse + 'static) -> SharedPulse

Erase an owned implementation. The implementation must not own the phase’s completion token: dropping clones must not finish the phase.

pub fn as_pulse(&self) -> &dyn Pulse

Borrow the underlying pulse, preserving the canonical no-op fast path.

pub fn plan( &self, execution: Execution, parts: &[PhaseSpec<'_>], ) -> Vec<Child<'_>>

Best-effort planning, as for a borrowed pulse; see <dyn Pulse>::plan.

Trait Implementations

impl Clone for SharedPulse

fn clone(&self) -> SharedPulse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SharedPulse

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

Formats the value using the given formatter.

impl Default for SharedPulse

fn default() -> SharedPulse

Returns the “default value” for a type.

impl Pulse for SharedPulse

fn record_issue(&self, error: PlanError)

Record a reporting-protocol problem for optional diagnostics. This never changes cancellation or the operation’s return value. Ordinary sinks may ignore it; diagnostic wrappers retain bounded evidence.

fn split( &self, execution: Execution, parts: &[PhaseSpec<'_>], ) -> Result<Vec<Child<'_>>, PlanError>

Split this phase into weighted children, in declared order.

fn start(&self) -> Result<(), PlanError>

Mark this phase running, without counting or ending planning. Implementations without lifecycle observations may ignore this.

fn set_total(&self, total: Total) -> Result<(), PlanError>

Revise a leaf’s denominator without changing completed units or weights. Unsupported implementations return an error instead of losing the update.

fn share(&self) -> Result<SharedPulse, PlanError>

Share all pulse capabilities with owned work, but never completion rights.

impl Report for SharedPulse

fn advance(&self, n: u64)

Add completed finished units.

fn may_report(&self) -> bool

Whether reports have any effect.

impl Stop for SharedPulse

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop.

fn may_stop(&self) -> bool

Returns true if this stop can ever signal a stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.