Struct kwp::Parser

pub struct Parser<'a> {
    pub prefixes: Prefixes<'a>,
    // some fields omitted
}

Represents the main parser

Fields

prefixes: Prefixes<'a>

Implementations

impl<'a> Parser<'a>

pub fn new(input: &str, prefixes: Prefixes<'a>) -> Self

Creates a new parser

Example

use kwp::{Parser, Prefixes};

let parser = Parser::new("+foo,-bar", Prefixes::default());

pub fn should_retain_prefix(&mut self, bool: bool) -> bool

Wether or not to retain the prefix when parsing keywords. If set to true, the prefix of values will be stripped upon parsing.

Example

use kwp::{Parser, Prefixes};

let mut parser = Parser::new("+foo", Prefixes::default());
parser.should_retain_prefix(true);

let keywords = parser.parse();
assert_eq!(keywords.positive, vec!["+foo"]);
// assert_ne!(keywords.positive, vec!["foo"]);

pub fn parse(&self) -> Keywords

Parses the input.

Example

use kwp::{Parser, Prefixes};

let parser = Parser::new("+foo,-bar,-baz", Prefixes::default());
println!("{:#?}", parser.parse());

pub fn match_products(
    &self,
    products: Vec<&str>,
    keywords: Keywords
) -> Vec<String>

Finds products that match the provided positive & negative keywords.
⚠️ Case insensitive

Example

use kwp::{Parser, Prefixes};
 
let products = vec!["MyProduct Adult", "MyProduct Youth"];
    let parser = Parser::new(
        "+myproduct,-youth",
        Prefixes {
            positive: "+",
            negative: "-",
        },
    );
let keywords = parser.parse();

let products = parser.match_products(products.clone(), keywords.clone());
assert_eq!(products, vec!["MyProduct Adult"]);