Struct lib_ruby_parser::ParserOptions

pub struct ParserOptions {
    pub buffer_name: String,
    pub debug: bool,
    pub decoder: CustomDecoder,
}

Configuration of the parser

Fields

buffer_name: String

Name of the buffer. Used in all diagnostic messages

debug: bool

Controls whether the parser should run in debug mode

Debug mode forces parser/lexer to print additional information while running (like bison actions)

decoder: CustomDecoder

Custom decoder that can be used if the source is encoded in unknown encoding. Only UTF-8 and ASCII-8BIT/BINARY are supported out of the box.

Example

use lib_ruby_parser::source::{InputError, RecognizedEncoding, CustomDecoder};
use lib_ruby_parser::{Parser, ParserOptions, ParserResult};

fn decode(encoding: RecognizedEncoding, input: &[u8]) -> Result<Vec<u8>, InputError> {
    if let RecognizedEncoding::US_ASCII = encoding {
        // reencode and return Ok(result)
        return Ok(b"# encoding: us-ascii\ndecoded".to_vec());
    }
    Err(InputError::DecodingError(
        "only us-ascii is supported".to_owned(),
    ))
}

// Or
let decode_closure = |encoding: RecognizedEncoding, input: &[u8]| -> Result<Vec<u8>, InputError> {
    if let RecognizedEncoding::US_ASCII = encoding {
        // reencode and return Ok(result)
        return Ok(b"# encoding: us-ascii\ndecoded".to_vec());
    }
    Err(InputError::DecodingError(
        "only us-ascii is supported".to_owned(),
    ))
};

let decoder = CustomDecoder::new(Box::new(decode_closure));
let options = ParserOptions { decoder, debug: true, ..Default::default() };
let mut parser = Parser::new(b"# encoding: us-ascii\n3 + 3", options);
let ParserResult { ast, input, .. } = parser.do_parse();

assert_eq!(ast.unwrap().expression().source(&input).unwrap(), "decoded".to_owned())

Trait Implementations

impl Default for ParserOptions

pub fn default() -> Self

Returns the "default value" for a type.