Skip to main content

DistributedSampler

Struct DistributedSampler 

Source
pub struct DistributedSampler<S> { /* private fields */ }
Expand description

A source wrapper that shards samples across distributed ranks.

Only samples where index % world_size == rank are yielded. The source item’s position within the underlying iterator determines the index.

use tenshift_core::sample::Sample;
use tenshift_core::source::Source;
use tenshift_core::sources::{DistributedSampler, MemorySource};

let source = MemorySource::new("demo", vec![Sample::new(), Sample::new(), Sample::new()]);
let shard = DistributedSampler::new(source, 1, 2).unwrap();
assert_eq!(shard.len_hint(), Some(1));

Implementations§

Source§

impl<S> DistributedSampler<S>

Source

pub fn new(inner: S, rank: usize, world_size: usize) -> Result<Self>
where S: Source,

Create a distributed sampler over an existing source.

§Errors

Returns Error::InvalidConfig when world_size == 0 or rank >= world_size.

Trait Implementations§

Source§

impl<S> Source for DistributedSampler<S>
where S: Source,

Source§

fn open(&self) -> Result<Box<dyn SourceIterator>>

Create an iterator over samples from this source. Read more
Source§

fn len_hint(&self) -> Option<u64>

Optional hint about the total number of samples. Read more
Source§

fn name(&self) -> &str

Human-readable name for this source (for logging and error messages).

Auto Trait Implementations§

§

impl<S> Freeze for DistributedSampler<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for DistributedSampler<S>
where S: RefUnwindSafe,

§

impl<S> Send for DistributedSampler<S>
where S: Send,

§

impl<S> Sync for DistributedSampler<S>
where S: Sync,

§

impl<S> Unpin for DistributedSampler<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for DistributedSampler<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for DistributedSampler<S>
where S: UnwindSafe,

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> AsyncSource for T
where T: Source,

Source§

fn open_async( &self, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn AsyncSourceIterator>, Error>> + Send + '_>>

Open the source asynchronously and return an async iterator.
Source§

fn len_hint(&self) -> Option<u64>

Optional hint about the total number of samples.
Source§

fn name(&self) -> &str

Human-readable name for this source.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more