Struct gds::GdsLibrary

pub struct GdsLibrary {

    pub name: ArcStr,
    pub version: i16,
    pub dates: GdsDateTimes,
    pub units: GdsUnits,
    pub structs: Vec<GdsStruct>,
    pub libdirsize: Unsupported,
    pub srfname: Unsupported,
    pub libsecur: Unsupported,
    pub reflibs: Unsupported,
    pub fonts: Unsupported,
    pub attrtable: Unsupported,
    pub generations: Unsupported,
    pub format_type: Unsupported,
}

A GDS library.

The Library is GDSII’s primary idiom for a suite of layout-cells. A Library generally corresponds one-to-one with a .gds file. Libraries consist primarily of cell-definitions (GdsStructs), and secondarily include library-level meta-data, including the distance units, GDS-spec version, and modification dates.

Several more esoteric library-level GDSII features are included as GdsLibrary fields, but are not materially supported. The empty Unsupported value generally denotes these fields.

Spec BNF:

HEADER BGNLIB [LIBDIRSIZE] [SRFNAME] [LIBSECUR] LIBNAME [REFLIBS] [FONTS] [ATTRTABLE] [GENERATIONS] [<FormatType>]
UNITS {<structure>}* ENDLIB

Fields

name: ArcStr

Library name.

version: i16

Gds spec version.

dates: GdsDateTimes

Modification date(s).

units: GdsUnits

Spatial units.

structs: Vec<GdsStruct>

Struct definitions.

libdirsize: Unsupported

srfname: Unsupported

libsecur: Unsupported

reflibs: Unsupported

fonts: Unsupported

attrtable: Unsupported

generations: Unsupported

format_type: Unsupported

Implementations

impl GdsLibrary

pub fn new(name: impl Into<ArcStr>) -> Self

Creates a new and empty GdsLibrary.

pub fn with_units(name: impl Into<ArcStr>, units: GdsUnits) -> Self

Creates a new and empty GdsLibrary with the given units.

pub fn load(fname: impl AsRef<Path>) -> GdsResult<GdsLibrary>

Reads a GDS loaded from file at path fname.

pub fn from_bytes(bytes: Vec<u8>) -> GdsResult<GdsLibrary>

Reads a GdsLibrary from byte-vector bytes.

pub fn stats(&self) -> GdsStats

Collects and returns the library’s aggregate statistics (numbers of structs, elements by type).

pub fn save(&self, fname: impl AsRef<Path>) -> GdsResult<()>

Saves to file at path fname.

pub fn write(&self, file: impl Write) -> GdsResult<()>

Writes to file file.

Trait Implementations

impl Clone for GdsLibrary

fn clone(&self) -> GdsLibrary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GdsLibrary

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

Formats the value using the given formatter.

impl Default for GdsLibrary

fn default() -> GdsLibrary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GdsLibrary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GdsLibrary

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SerdeFile for GdsLibrary

fn save( &self, fmt: SerializationFormat, fname: impl AsRef<Path> ) -> Result<(), Error>

Saves in fmt-format to file fname.

fn open( fname: impl AsRef<Path>, fmt: SerializationFormat ) -> Result<Self, Error>

Opens from fmt-format file fname.

impl Serialize for GdsLibrary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GdsLibrary