Struct Plan 

pub struct Plan { /* private fields */ }

The analysis result for one pipeline.

Implementations

impl Plan

pub fn build(image: &Image, options: PlanOptions) -> Result<Self>

Analyse image’s graph.

Errors

Propagates Op::input_regions for any op whose demand mapping rejects a region this plan would ask for.

pub fn node(&self, id: NodeId) -> Option<NodePlan>

The plan for one node, if it is part of this pipeline.

pub fn output_tiles(&self) -> &[Region]

The output regions the sink will pull, in order.

pub const fn root(&self) -> NodeId

The root node this plan was built for.

pub fn len(&self) -> usize

How many nodes the plan covers.

pub fn is_empty(&self) -> bool

Whether the plan covers no nodes.

pub fn materializes(&self) -> bool

Whether any node in the pipeline must be materialized.

A pipeline with no materialization points runs in memory bounded by tiles in flight; one with them buffers a full intermediate per point (SPEC §Guarantees 1).

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.