Struct PcbDoc 

pub struct PcbDoc {
    pub board_params: ParameterCollection,
    pub components: Vec<PcbDocComponent>,
    pub primitives: Vec<PcbRecord>,
    pub nets: Vec<String>,
    pub rules: Vec<PcbRule>,
    pub classes: Vec<PcbClass>,
    pub placer_options: Option<PcbAdvancedPlacerOptions>,
    pub drc_options: Option<PcbDrcOptions>,
    pub pin_swap_options: Option<PcbPinSwapOptions>,
}

A PCB document containing board data.

Fields

board_params: ParameterCollection

Board header parameters.

components: Vec<PcbDocComponent>

Components placed on the board.

primitives: Vec<PcbRecord>

Board primitives (not associated with components).

nets: Vec<String>

Nets in the design.

rules: Vec<PcbRule>

Design rules.

classes: Vec<PcbClass>

Object classes (net classes, component classes, etc.).

placer_options: Option<PcbAdvancedPlacerOptions>

Advanced placer options.

drc_options: Option<PcbDrcOptions>

Design rule checker options.

pin_swap_options: Option<PcbPinSwapOptions>

Pin swap options.

Implementations

impl PcbDoc

pub fn open<R: Read + Seek>(reader: R) -> Result<Self>

Open and read a PcbDoc file.

pub fn open_file<P: AsRef<Path>>(path: P) -> Result<Self>

Open and read a PcbDoc file from a path.

pub fn save_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the PcbDoc to a file path.

This performs a read-modify-write operation: it reads the existing file, updates the rules stream, and writes back to the same path.

pub fn save_board_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save board parameters to a file path.

This performs a read-modify-write operation: it reads the existing file, updates the Board6/Data stream, and writes back.

pub fn save_regions_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save regions (keepouts/cutouts) to a file path.

This performs a read-modify-write operation.

pub fn save_polygons_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save polygons (copper pours) to a file path.

This performs a read-modify-write operation.

pub fn component_count(&self) -> usize

Get the number of components.

pub fn primitive_count(&self) -> usize

Get the number of primitives.

pub fn net_count(&self) -> usize

Get the number of nets.

pub fn rule_count(&self) -> usize

Get the number of design rules.

pub fn iter_rules(&self) -> impl Iterator<Item = &PcbRule>

Iterate over design rules.

pub fn iter_rules_mut(&mut self) -> impl Iterator<Item = &mut PcbRule>

Iterate over design rules mutably.

pub fn add_rule(&mut self, rule: PcbRule)

Add a design rule.

pub fn find_rule(&self, name: &str) -> Option<&PcbRule>

Find a rule by name.

pub fn find_rule_mut(&mut self, name: &str) -> Option<&mut PcbRule>

Find a rule by name mutably.

pub fn iter_components(&self) -> impl Iterator<Item = &PcbDocComponent>

Iterate over components.

pub fn iter_primitives(&self) -> impl Iterator<Item = &PcbRecord>

Iterate over primitives.

pub fn track_count(&self) -> usize

Count tracks.

pub fn via_count(&self) -> usize

Count vias.

pub fn pad_count(&self) -> usize

Count pads (from components).

pub fn find_component(&self, designator: &str) -> Option<&PcbDocComponent>

Find a component by designator.

pub fn find_component_mut( &mut self, designator: &str, ) -> Option<&mut PcbDocComponent>

Find a component by designator mutably.

pub fn iter_components_mut( &mut self, ) -> impl Iterator<Item = &mut PcbDocComponent>

Iterate over components mutably.

pub fn save_with_components<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save with component changes.

pub fn save_all_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save all primitives to a file path.

This comprehensive save method writes all primitive types:

• Tracks
• Vias
• Arcs
• Fills
• Regions
• Polygons
• Components
• Rules

pub fn arc_count(&self) -> usize

Count arcs.

pub fn fill_count(&self) -> usize

Count fills.

pub fn region_count(&self) -> usize

Count regions.

pub fn polygon_count(&self) -> usize

Count polygons.

pub fn text_count(&self) -> usize

Count text elements.

pub fn add_track(&mut self, track: PcbTrack)

Add a track.

pub fn add_via(&mut self, via: PcbVia)

Add a via.

pub fn add_arc(&mut self, arc: PcbArc)

Add an arc.

pub fn add_fill(&mut self, fill: PcbFill)

Add a fill.

pub fn add_region(&mut self, region: PcbRegion)

Add a region.

pub fn add_polygon(&mut self, polygon: PcbPolygon)

Add a polygon.

pub fn remove_primitive(&mut self, index: usize) -> Option<PcbRecord>

Remove primitive at index.

pub fn get_primitive(&self, index: usize) -> Option<&PcbRecord>

Get primitive at index.

pub fn get_primitive_mut(&mut self, index: usize) -> Option<&mut PcbRecord>

Get mutable primitive at index.

pub fn iter_tracks(&self) -> impl Iterator<Item = &PcbTrack>

Iterate over tracks.

pub fn iter_vias(&self) -> impl Iterator<Item = &PcbVia>

Iterate over vias.

pub fn iter_arcs(&self) -> impl Iterator<Item = &PcbArc>

Iterate over arcs.

pub fn iter_fills(&self) -> impl Iterator<Item = &PcbFill>

Iterate over fills.

pub fn iter_regions(&self) -> impl Iterator<Item = &PcbRegion>

Iterate over regions.

pub fn iter_polygons(&self) -> impl Iterator<Item = &PcbPolygon>

Iterate over polygons.

pub fn iter_texts(&self) -> impl Iterator<Item = &PcbText>

Iterate over texts.

pub fn add_text(&mut self, text: PcbText)

Add a text annotation.

Trait Implementations

impl Debug for PcbDoc

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

Formats the value using the given formatter.

impl Default for PcbDoc

fn default() -> PcbDoc

Returns the “default value” for a type.

impl DumpTree for PcbDoc

fn dump(&self, tree: &mut TreeBuilder)

Dump this item to the tree builder.

fn dump_to_string(&self) -> String

Convenience method to dump to a string.

fn dump_to_string_with_options(&self, options: DumpOptions) -> String

Convenience method to dump to a string with options.