Struct rayon_core::BroadcastContext

pub struct BroadcastContext<'a> {
    worker: &'a WorkerThread,
    _marker: PhantomData<&'a mut dyn Fn()>,
}

Provides context to a closure called by broadcast.

Fields

worker: &'a WorkerThread

_marker: PhantomData<&'a mut dyn Fn()>

Make sure to prevent auto-traits like Send and Sync.

Implementations

impl<'a> BroadcastContext<'a>

pub(crate) fn with<R>(f: impl FnOnce(BroadcastContext<'_>) -> R) -> R

pub fn index(&self) -> usize

Our index amongst the broadcast threads (ranges from 0..self.num_threads()).

pub fn num_threads(&self) -> usize

The number of threads receiving the broadcast in the thread pool.

Future compatibility note

Future versions of Rayon might vary the number of threads over time, but this method will always return the number of threads which are actually receiving your particular broadcast call.

Trait Implementations

impl<'a> Debug for BroadcastContext<'a>

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

Formats the value using the given formatter.