Struct cooklang::CooklangParser

pub struct CooklangParser { /* private fields */ }

A cooklang parser

Instantiating this takes time and the first parse may take longer. So you may want to create only one and reuse it.

The default parser enables all extensions.

The 2 main methods are CooklangParser::parse and CooklangParser::parse_metadata.

You can also skip using this struct and use parser::PullParser and analysis::parse_events.

Implementations

impl CooklangParser

pub fn new(extensions: Extensions, converter: Converter) -> Self

Creates a new parser.

It is encouraged to reuse the parser and not rebuild it every time.

pub fn extended() -> Self

Creates a new extended parser

This enables all extensions and uses the bunlded units. It is encouraged to reuse the parser and not rebuild it every time.

pub fn canonical() -> Self

Creates a new canonical parser

This disables all extensions and does not use units.

It is encouraged to reuse the parser and not rebuild it every time.

pub fn converter(&self) -> &Converter

Get the parser inner converter

pub fn extensions(&self) -> Extensions

Get the enabled extensions

pub fn parse(&self, input: &str) -> RecipeResult

Parse a recipe

pub fn parse_with_options( &self, input: &str, options: ParseOptions<'_>, ) -> RecipeResult

Same as Self::parse but with aditional options

pub fn parse_metadata(&self, input: &str) -> MetadataResult

Parse only the metadata of a recipe

This is a bit faster than Self::parse if you only want the metadata

pub fn parse_metadata_with_options( &self, input: &str, options: ParseOptions<'_>, ) -> MetadataResult

Same as Self::parse_metadata but with aditional options

Trait Implementations

impl Clone for CooklangParser

fn clone(&self) -> CooklangParser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CooklangParser

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

Formats the value using the given formatter.

impl Default for CooklangParser

fn default() -> CooklangParser

Returns the “default value” for a type.

impl PartialEq for CooklangParser

fn eq(&self, other: &CooklangParser) -> 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 StructuralPartialEq for CooklangParser