Struct ParserOptions 

pub struct ParserOptions { /* private fields */ }

Caller-provided configuration for the parser.

Custom filters

The built-in filter vocabulary (is:unread, has:attachment, etc.) is fixed at compile time. Anything else — is:owed-reply, has:reaction, is:my-app-flag — returns ParseError::UnknownFilter by default. Register the names you want to accept so they parse as FilterKind::Custom instead.

use mail_query::{parse_with, FilterKind, ParserOptions, QueryNode};

let mut options = ParserOptions::default();
options.register_custom_filter("owed-reply");

let ast = parse_with("is:owed-reply", &options).expect("parses");
assert_eq!(
    ast,
    QueryNode::Filter(FilterKind::Custom("owed-reply".into()))
);

Implementations

impl ParserOptions

pub fn new() -> Self

New empty options. Equivalent to Default::default.

pub fn register_custom_filter(&mut self, name: impl Into<String>) -> &mut Self

Register a custom filter name. The crate canonicalises to lowercase + hyphenated form (Reply_Later becomes reply-later), so callers can pass any casing.

pub fn register_custom_filters<I, S>(&mut self, names: I) -> &mut Self

where I: IntoIterator<Item = S>, S: Into<String>,

Register many custom filter names at once.

Trait Implementations

impl Debug for ParserOptions

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

Formats the value using the given formatter.

impl Default for ParserOptions

fn default() -> ParserOptions

Returns the “default value” for a type.