gcode 0.4.0

A gcode parser for no-std applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! A gcode parsing library designed for `no_std` environments.
//!
//! # Feature Flags
//!
//! To help reduce compilation times and overall code size, this crate puts
//! extra functionality behind several `cargo` features.
//!
//! - `std`: Enables various features/optimisations which require allocation
//!   or implementing traits from `std` (e.g. `std::error::Error`).
//! - `transforms`: Exposes the transformations API for manipulating `Gcode`s
//!   before executing or writing to a file.
//! - `large-buffers` (on-by-default): Increases the number of commands,
//!   comments and arguments which can be added to a block (see
//!   [`Block::MAX_COMMENT_COUNT`], [`Block::MAX_COMMAND_COUNT`], and
//!   [`Gcode::MAX_ARGUMENT_COUNT`] for more).

#![cfg_attr(not(feature = "std"), no_std)]
#![deny(
    missing_docs,
    missing_debug_implementations,
    missing_copy_implementations,
    trivial_casts,
    trivial_numeric_casts,
    unsafe_code,
    unstable_features,
    unused_import_braces,
    unused_qualifications
)]

extern crate arrayvec;
#[macro_use]
extern crate cfg_if;
#[cfg(feature = "std")]
extern crate core;
extern crate libm;

#[cfg(all(not(feature = "std"), test))]
#[macro_use]
extern crate std;
#[cfg(test)]
#[macro_use]
extern crate pretty_assertions;

mod lexer;
mod parser;
#[cfg(feature = "transforms")]
pub mod transforms;
mod types;

pub use crate::parser::*;
#[cfg(feature = "transforms")]
pub use crate::transforms::GcodeTransforms;
pub use crate::types::*;

/// Convenience function for parsing a string of text into `Gcode`s, ignoring
/// any errors which may occur.
pub fn parse<'input>(src: &'input str) -> impl Iterator<Item = Gcode> + 'input {
    Parser::new(src).flat_map(|block| block.into_commands())
}