Struct GCode

pub struct GCode<A = DefaultArguments> { /* private fields */ }

The in-memory representation of a single command in the G-code language (e.g. "G01 X50.0 Y-20.0").

Implementations

impl GCode

pub fn new(mnemonic: Mnemonic, number: f32, span: Span) -> Self

Create a new GCode which uses the DefaultArguments buffer.

impl<A: Buffer<Word>> GCode<A>

pub fn new_with_argument_buffer( mnemonic: Mnemonic, number: f32, span: Span, arguments: A, ) -> Self

Create a new GCode which uses a custom Buffer.

pub fn mnemonic(&self) -> Mnemonic

The overall category this GCode belongs to.

pub fn major_number(&self) -> u32

The integral part of a command number (i.e. the 12 in G12.3).

pub fn minor_number(&self) -> u32

The fractional part of a command number (i.e. the 3 in G12.3).

pub fn arguments(&self) -> &[Word]

The arguments attached to this GCode.

pub fn span(&self) -> Span

Where the GCode was found in its source text.

pub fn push_argument(&mut self, arg: Word) -> Result<(), CapacityError<Word>>

Add an argument to the list of arguments attached to this GCode.

pub fn with_argument(self, arg: Word) -> Self

The builder equivalent of GCode::push_argument().

Panics

This will panic if the underlying Buffer returns a CapacityError.

pub fn value_for(&self, letter: char) -> Option<f32>

Get the value for a particular argument.

Examples

let gcode = GCode::new(Mnemonic::General, 1.0, Span::PLACEHOLDER)
    .with_argument(Word::new('X', 30.0, Span::PLACEHOLDER))
    .with_argument(Word::new('Y', -3.14, Span::PLACEHOLDER));

assert_eq!(gcode.value_for('Y'), Some(-3.14));

Trait Implementations

impl<A: Clone> Clone for GCode<A>

fn clone(&self) -> GCode<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Buffer<Word>> Debug for GCode<A>

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

Formats the value using the given formatter.

impl<'de, A> Deserialize<'de> for GCode<A>

where A: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A: Buffer<Word>> Display for GCode<A>

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

Formats the value using the given formatter.

impl<A: Buffer<Word>> Extend<Word> for GCode<A>

fn extend<I: IntoIterator<Item = Word>>(&mut self, words: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<A, B> PartialEq<GCode<B>> for GCode<A>

where A: Buffer<Word>, B: Buffer<Word>,

fn eq(&self, other: &GCode<B>) -> 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<A> Serialize for GCode<A>

where A: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.