Gcode.Parser (gcode v1.0.0)

A parser for G-code programs.

This parser converts G-code input (in UTF-8 encoding) into representations with the contents of Gcode.Model.

Link to this section Summary

parse_file(path)

Attempt to parse the G-code program at the given path.

parse_string(input)

Attempt to parse a G-code program from a string.

stream_file!(path)

Parse and stream the G-code program at the given location.

Parse and stream the G-code program from a string.

@spec parse_file(Path.t()) ::
  Gcode.Result.t(
    Gcode.Model.Program.t(),
    {:parse_error, String.t()}
  )

Attempt to parse the G-code program at the given path.

@spec parse_string(String.t()) ::
  Gcode.Result.t(
    Gcode.Model.Program.t(),
    {:parse_error, String.t()}
  )

Attempt to parse a G-code program from a string.

@spec stream_file!(Path.t()) :: Enumerable.t() | no_return()

Parse and stream the G-code program at the given location.

Note that this function doesn't yield Program objects, but blocks, comments, etc.

@spec stream_string!(String.t()) :: Enumerable.t() | no_return()

Parse and stream the G-code program from a string.

Note that this function doesn't yield Program objects, but blocks, comments, etc.