Struct FootprintDocument 

pub struct FootprintDocument { /* private fields */ }

Implementations

impl FootprintDocument

pub fn ast(&self) -> &FootprintAst

Examples found in repository

examples/footprint_roundtrip.rs (line 25)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

examples/read_all.rs (line 18)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let base = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("examples")
        .join("data");

    let pcb = PcbFile::read(base.join("sample.kicad_pcb"))?;
    println!("pcb version: {:?}", pcb.ast().version);
    println!("pcb unknown nodes: {}", pcb.ast().unknown_nodes.len());

    let footprint = FootprintFile::read(base.join("sample.kicad_mod"))?;
    println!("footprint version: {:?}", footprint.ast().version);

    let schematic = SchematicFile::read(base.join("sample.kicad_sch"))?;
    println!("schematic version: {:?}", schematic.ast().version);
    println!(
        "schematic unknown nodes: {}",
        schematic.ast().unknown_nodes.len()
    );

    let table = FpLibTableFile::read(base.join("fp-lib-table"))?;
    println!("fp libs: {}", table.ast().library_count);

    let sym_table = SymLibTableFile::read(base.join("sym-lib-table"))?;
    println!("sym libs: {}", sym_table.ast().library_count);

    let dru = DesignRulesFile::read(base.join("sample.kicad_dru"))?;
    println!("rules: {}", dru.ast().rule_count);
    println!("rule constraints: {}", dru.ast().total_constraint_count);

    let project = ProjectFile::read(base.join("sample.kicad_pro"))?;
    println!("project meta version: {:?}", project.ast().meta_version);

    let worksheet = WorksheetFile::read(base.join("sample.kicad_wks"))?;
    println!("worksheet version: {:?}", worksheet.ast().version);
    println!("worksheet tbtext count: {}", worksheet.ast().tbtext_count);

    pcb.write_mode("/tmp/out.kicad_pcb", WriteMode::Lossless)?;
    Ok(())
}

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

pub fn set_lib_id<S: Into<String>>(&mut self, lib_id: S) -> &mut Self

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

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

Examples found in repository

examples/footprint_roundtrip.rs (line 16)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

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

Examples found in repository

examples/footprint_roundtrip.rs (line 17)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

pub fn set_layer<S: Into<String>>(&mut self, layer: S) -> &mut Self

pub fn set_descr<S: Into<String>>(&mut self, descr: S) -> &mut Self

pub fn set_tags<S: Into<String>>(&mut self, tags: S) -> &mut Self

pub fn set_reference<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn set_value<S: Into<String>>(&mut self, value: S) -> &mut Self

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

Examples found in repository

examples/footprint_roundtrip.rs (line 18)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

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

pub fn cst(&self) -> &CstDocument

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

Examples found in repository

examples/footprint_roundtrip.rs (line 28)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

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

Examples found in repository

examples/footprint_roundtrip.rs (line 20)

fn main() -> Result<(), String> {
    let mut args = env::args().skip(1);
    let in_path = args.next().map(PathBuf::from).ok_or_else(usage)?;
    let out_path = args.next().map(PathBuf::from).ok_or_else(usage)?;

    let mut doc = FootprintFile::read(&in_path).map_err(|e| e.to_string())?;
    doc.set_generator("kiutils")
        .set_generator_version("roundtrip-demo")
        .upsert_property("EditedBy", "kiutils_kicad/examples/footprint_roundtrip.rs");

    doc.write(&out_path).map_err(|e| e.to_string())?;

    let reread = FootprintFile::read(&out_path).map_err(|e| e.to_string())?;
    println!("input: {}", in_path.display());
    println!("output: {}", out_path.display());
    println!("lib_id: {:?}", reread.ast().lib_id);
    println!("properties: {}", reread.ast().property_count);
    println!("unknown_nodes: {}", reread.ast().unknown_nodes.len());
    println!("diagnostics: {}", reread.diagnostics().len());

    Ok(())
}

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

Trait Implementations

impl Clone for FootprintDocument

fn clone(&self) -> FootprintDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FootprintDocument

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

Formats the value using the given formatter.