Skip to main content

PcbDocument

Struct PcbDocument 

Source
pub struct PcbDocument { /* private fields */ }
Expand description

PCB (.kicad_pcb) APIs.

Implementations§

Source§

impl PcbDocument

Source

pub fn ast(&self) -> &PcbAst

Source

pub fn ast_mut(&mut self) -> &mut PcbAst

Source

pub fn set_version(&mut self, version: i32) -> &mut PcbDocument

Source

pub fn set_generator<S>(&mut self, generator: S) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_generator_version<S>( &mut self, generator_version: S, ) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_paper_standard<S>( &mut self, kind: S, orientation: Option<&str>, ) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_paper_user( &mut self, width: f64, height: f64, orientation: Option<&str>, ) -> &mut PcbDocument

Source

pub fn set_title<S>(&mut self, title: S) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_date<S>(&mut self, date: S) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_revision<S>(&mut self, revision: S) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn set_company<S>(&mut self, company: S) -> &mut PcbDocument
where S: Into<String>,

Source

pub fn upsert_property<K, V>(&mut self, key: K, value: V) -> &mut PcbDocument
where K: Into<String>, V: Into<String>,

Source

pub fn remove_property(&mut self, key: &str) -> &mut PcbDocument

Source

pub fn cst(&self) -> &CstDocument

Source

pub fn diagnostics(&self) -> &[Diagnostic]

Source

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

Source

pub fn write_mode<P>(&self, path: P, mode: WriteMode) -> Result<(), Error>
where P: AsRef<Path>,

Trait Implementations§

Source§

impl Clone for PcbDocument

Source§

fn clone(&self) -> PcbDocument

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PcbDocument

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.