Struct Program 

pub struct Program {
    pub steps: Vec<Step>,
}

A recipe for building a Part: an ordered list of steps, each referring to what earlier ones built only by name. Those names come from step ids and sketch element ids, never from the internal ids a build happens to assign (see geop_core_part), so a program means the same thing every time it is run — including after a round trip through JSON.

Fields

steps: Vec<Step>

Implementations

impl Program

pub fn new() -> Self

pub fn push( &mut self, id: impl Into<String>, operation: impl Into<PartOperation>, )

Appends the step id: operation with its arguments.

pub fn index_of(&self, id: &str) -> GeopResult<usize>

The position of step id.

pub fn fresh_id(&self, operation: &PartOperation) -> String

An id no step has yet, for a new step running operation: its label, lowercased, and the lowest number that makes it unique — sketch1, extrude2.

pub fn validate(&self) -> GeopResult<()>

Checks that every step id is a valid operation id and unique: every name a step creates is built from its id.

pub fn update(&mut self, edit: ProgramEdit) -> GeopResult<Option<String>>

Applies edit, returning the id of the step it inserted, changed or moved (None for a removal or a replacement). An edit that would leave the program invalid — an unknown step, a position past the end, a duplicate or malformed id — is rejected and changes nothing.

This only changes the recipe; whether the steps still build is for running it to say (see ProgramRunner).

pub fn apply<S: Scalar>(&self, part: Part<S>) -> GeopResult<Part<S>>

Runs every step in order, starting from part (typically Part::new), and returns the part the whole program builds — or the first error any step raises, at which point the steps after it never run.

After each step, every entity of the part must have a name — an operation that leaves one unnamed has broken the one guarantee a program relies on.

pub fn to_json(&self) -> GeopResult<String>

The program as pretty-printed JSON: one step per object, every sketch entity keyed by its id, so edits show up as small line diffs.

pub fn from_json(json: &str) -> GeopResult<Self>

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl Default for Program

fn default() -> Program

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Program

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Program

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Program

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 Program