Struct SchDoc 

pub struct SchDoc {
    pub primitives: Vec<SchRecord>,
    pub document_name: Option<String>,
}

A schematic document containing primitives.

Fields

primitives: Vec<SchRecord>

All primitives in the document.

document_name: Option<String>

Optional document name (typically the filename without extension). This is used as the sheet name in queries, not the Title parameter.

Implementations

impl SchDoc

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

Open and read a SchDoc file.

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

Open and read a SchDoc file from a path.

pub fn save<W: Read + Write + Seek>(&self, writer: W) -> Result<()>

Save the SchDoc to a file.

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

Save the SchDoc to a file path.

pub fn sheet_header(&self) -> Option<&SchSheetHeader>

Get the sheet header if present.

pub fn components(&self) -> impl Iterator<Item = &SchComponent>

Get all components in the document.

pub fn wires(&self) -> impl Iterator<Item = &SchWire>

Get all wires in the document.

pub fn primitive_count(&self) -> usize

Get the number of primitives.

Trait Implementations

impl Debug for SchDoc

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

Formats the value using the given formatter.

impl Default for SchDoc

fn default() -> SchDoc

Returns the “default value” for a type.

impl DumpTree for SchDoc

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.