Struct timely::dataflow::scopes::child::Child

pub struct Child<'a, G, T>
where
    G: ScopeParent,
    T: Timestamp + Refines<G::Timestamp>,
{
    pub subgraph: &'a RefCell<SubgraphBuilder<G::Timestamp, T>>,
    pub parent: G,
    pub logging: Option<TimelyLogger>,
    pub progress_logging: Option<TimelyProgressLogger>,
}

A Child wraps a Subgraph and a parent G: Scope. It manages the addition of Operates to a subgraph, and the connection of edges between them.

Fields

subgraph: &'a RefCell<SubgraphBuilder<G::Timestamp, T>>

The subgraph under assembly.

parent: G

A copy of the child’s parent scope.

logging: Option<TimelyLogger>

The log writer for this scope.

progress_logging: Option<TimelyProgressLogger>

The progress log writer for this scope.

Implementations

impl<G, T> Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

pub fn index(&self) -> usize

This worker’s unique identifier.

Ranges from 0 to self.peers() - 1.

pub fn peers(&self) -> usize

The total number of workers in the computation.

Trait Implementations

impl<G, T> AsWorker for Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

fn config(&self) -> &Config

Returns the worker configuration parameters.

fn index(&self) -> usize

Index of the worker among its peers.

fn peers(&self) -> usize

Number of peer workers.

fn allocate<D: Exchangeable>( &mut self, identifier: usize, address: Rc<[usize]>, ) -> (Vec<Box<dyn Push<D>>>, Box<dyn Pull<D>>)

Allocates a new channel from a supplied identifier and address.

fn pipeline<D: 'static>( &mut self, identifier: usize, address: Rc<[usize]>, ) -> (ThreadPusher<D>, ThreadPuller<D>)

Constructs a pipeline channel from the worker to itself.

fn new_identifier(&mut self) -> usize

Allocates a new worker-unique identifier.

fn peek_identifier(&self) -> usize

The next worker-unique identifier to be allocated.

fn log_register(&self) -> RefMut<'_, Registry>

Provides access to named logging streams.

fn logging(&self) -> Option<TimelyLogger>

Provides access to the timely logging stream.

impl<G, T> Clone for Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G, T> Scheduler for Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

fn activations(&self) -> Rc<RefCell<Activations>>

Provides a shared handle to the activation scheduler.

fn activator_for(&self, path: Rc<[usize]>) -> Activator

Constructs an Activator tied to the specified operator address.

fn sync_activator_for(&self, path: Vec<usize>) -> SyncActivator

Constructs a SyncActivator tied to the specified operator address.

impl<G, T> Scope for Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

fn name(&self) -> String

A useful name describing the scope.

fn addr(&self) -> Rc<[usize]>

A sequence of scope identifiers describing the path from the worker root to this scope.

fn addr_for_child(&self, index: usize) -> Rc<[usize]>

A sequence of scope identifiers describing the path from the worker root to the child indicated by index.

fn add_edge(&self, source: Source, target: Target)

Connects a source of data with a target of the data. This only links the two for the purposes of tracking progress, rather than effect any data movement itself.

fn add_operator_with_indices( &mut self, operator: Box<dyn Operate<Self::Timestamp>>, local: usize, global: usize, )

Adds a child Operate to the builder’s scope using supplied indices.

fn allocate_operator_index(&mut self) -> usize

Allocates a new scope-local operator index.

fn scoped<T2, R, F>(&mut self, name: &str, func: F) -> R

where T2: Timestamp + Refines<T>, F: FnOnce(&mut Child<'_, Self, T2>) -> R,

Creates a dataflow subgraph.

fn add_operator(&mut self, operator: Box<dyn Operate<Self::Timestamp>>) -> usize

Adds a child Operate to the builder’s scope. Returns the new child’s index.

fn add_operator_with_index( &mut self, operator: Box<dyn Operate<Self::Timestamp>>, index: usize, )

Adds a child Operate to the builder’s scope using a supplied index.

fn iterative<T, R, F>(&mut self, func: F) -> R

where T: Timestamp, F: FnOnce(&mut Child<'_, Self, Product<<Self as ScopeParent>::Timestamp, T>>) -> R,

Creates a iterative dataflow subgraph.

fn region<R, F>(&mut self, func: F) -> R

where F: FnOnce(&mut Child<'_, Self, <Self as ScopeParent>::Timestamp>) -> R,

Creates a dataflow region with the same timestamp.

fn region_named<R, F>(&mut self, name: &str, func: F) -> R

where F: FnOnce(&mut Child<'_, Self, <Self as ScopeParent>::Timestamp>) -> R,

Creates a dataflow region with the same timestamp.

impl<G, T> ScopeParent for Child<'_, G, T>

where G: ScopeParent, T: Timestamp + Refines<G::Timestamp>,

type Timestamp = T

The timestamp associated with data in this scope.