Struct Board 

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

A complete PCB stackup: an ordered collection of Layers of any type.

Layers are identified by their LayerType; each type may appear at most once. Use Board::add_layer to insert or merge a layer, and LayerMerge::merge to combine two boards that share the same layer set.

Implementations

impl Board

pub fn load(data: Vec<(&str, BufReader<&mut dyn Read>)>) -> LoadResult

Parses a board from a list of (filename, reader) pairs.

The layer type is inferred from the file name (see LayerType::from_file_name): the extension (e.g. .gtl → Top), or for .gbr files the KiCad layer name (e.g. -F_Courtyard.gbr). A specific X2 FileFunction embedded in the Gerber data takes precedence. Files with unrecognised extensions or parse failures are collected in LoadResult::errors so the caller can inspect them without losing the layers that did load correctly.

pub fn empty() -> Self

Creates a board with no layers.

pub fn comment(&mut self, txt: String)

Appends a comment command to every layer that supports it (Gerber and Excellon).

pub fn from_folder(path: &Path) -> Result<LoadResult>

Loads every file with a recognised Gerber or Excellon extension from path.

Files with unrecognised extensions are silently skipped. Returns an Err only if the directory itself cannot be read. Per-file open and parse failures are captured in LoadResult::errors so the caller can inspect them without losing the successfully loaded layers.

When the parallel feature is enabled, files are parsed concurrently using Rayon.

pub fn layers(&self) -> &[Layer]

Returns references to all layers in insertion order.

pub fn layers_mut(&mut self) -> &mut [Layer]

Returns mutable references to all layers in insertion order.

pub fn add_layer(&mut self, layer: impl Into<Layer>) -> Result<(), MergeError>

Inserts a layer into the board, or merges it into the existing layer of the same type if one is already present.

Accepts anything that converts into a Layer (e.g. GerberLayerData, ExcellonLayerData).

A failed merge leaves the board unchanged.

pub fn has_undefined(&self) -> bool

Returns true if any layer has type LayerType::UndefinedGerber.

pub fn get_undefined(&self) -> Vec<&Layer>

Returns all layers with type LayerType::UndefinedGerber.

pub fn get_undefined_mut(&mut self) -> Vec<&mut Layer>

Returns mutable references to all layers with type LayerType::UndefinedGerber.

pub fn get_layer(&self, ty: &LayerType) -> Option<&Layer>

Returns the layer with the given type, or None if not present.

pub fn get_layer_mut(&mut self, ty: &LayerType) -> Option<&mut Layer>

Returns a mutable reference to the layer with the given type, or None if not present.

pub fn write_to<T>( &self, options: &WriteOptions, f: &mut impl FnMut(&Layer) -> Result<BufWriter<T>>, ) -> Result<(), WriteError>

where T: Write,

Writes every layer through a writer obtained from f.

Unmodified layers are written as their original bytes. Everything is checked (names, and completeness of edited layers) before f is called for the first time, so a rejected export opens no writer.

pub fn check_write(&self, options: &WriteOptions) -> Result<(), WriteError>

Runs every check write_to performs before writing, without writing anything.

pub fn unresolved_edits(&self) -> Vec<(String, LayerDiagnostics)>

Edited layers that would be refused without WriteOptions::allow_incomplete, with their diagnostics.

pub fn diagnostics(&self) -> Vec<(String, LayerDiagnostics)>

Interpretation diagnostics of every layer, by layer name.

pub fn write_to_folder( &self, path: &Path, options: &WriteOptions, ) -> Result<(), WriteError>

Writes all layers to path, creating the directory if necessary.

Each layer is written to a file named layer.name inside path. Files are first written to temporary names and only renamed into place once every layer was written successfully, so a write failure leaves existing files untouched (the renames themselves are not atomic as a group).

Trait Implementations

impl Clone for Board

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 Board

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

Formats the value using the given formatter.

impl From<ExcellonLayerData> for Board

fn from(data: ExcellonLayerData) -> Self

Creates a board containing a single Excellon drill layer.

impl From<GerberLayerData> for Board

fn from(data: GerberLayerData) -> Self

Creates a board containing a single Gerber layer.

impl From<Layer> for Board

fn from(layer: Layer) -> Self

Creates a board containing a single layer.

impl From<Vec<Layer>> for Board

fn from(layers: Vec<Layer>) -> Self

Creates a board from a pre-built list of layers.

impl LayerCorners for Board

fn get_corners(&self) -> (Pos, Pos)

Returns the bounding box of the board.

Computed as the union of all layer corners (Gerber and Excellon drill), excluding KeepOut, Info, SidePlating and courtyard layers as they don’t represent physical board area.

fn get_size(&self) -> Size

Returns the bounding-box dimensions derived from get_corners.

impl LayerMerge for Board

fn merge(&mut self, other: &Self) -> Result<(), MergeError>

Merges layers from other into the corresponding layers of self.

Only layers whose LayerType already exists in self are updated. Layer types present in other but not in self are ignored — use add_layer to insert a new layer instead.

Every layer pair is checked first, so a failure on any layer leaves the whole board unchanged.

fn check_merge(&self, _other: &Self) -> Result<(), MergeError>

Checks whether merge would succeed, without changing anything.

fn merge_from(&mut self, other: impl Into<Self>) -> Result<(), MergeError>

Converts other into Self and merges it.

impl LayerRotate for Board

fn rotate(&mut self, steps: i32)

Rotate by steps CW quarter-turns about the layer’s own centroid.

fn rebase(&mut self, steps: i32, offset: &Pos)

Rotate by steps CW quarter-turns about the origin, then translate by offset (mm).

impl LayerTransform for Board

fn transform(&mut self, transform: &Pos)

Translates every layer by transform (mm).

impl PartialEq for Board

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Board