Add notes how the filter language should look like

This commit is contained in:
Matthias Beyer 2018-04-29 11:32:27 +02:00
parent 74c982984c
commit d518322401

View file

@ -43,3 +43,49 @@ impl<'a, A> Filter<StoreId> for IsInCollectionsFilter<'a, A>
} }
} }
/// Language definition for the header-filter language
///
/// # Notes
///
/// Here are some notes how the language should look like:
///
/// ```ignore
/// query = filter (operator filter)*
///
/// filter = unary? ((function "(" selector ")" ) | selector ) compare_op compare_val
///
/// unary = "not"
///
/// compare_op =
/// "is" |
/// "in" |
/// "==/eq" |
/// "!=/neq" |
/// ">=" |
/// "<=" |
/// "<" |
/// ">" |
/// "any" |
/// "all"
///
/// compare_val = val | listofval
///
/// val = string | int | float | bool
/// listofval = "[" (val ",")* "]"
///
/// operator =
/// "or" |
/// "or_not" |
/// "and" |
/// "and_not" |
/// "xor"
///
/// function =
/// "length" |
/// "keys" |
/// "values"
/// ```
///
mod header_filter_lang {
}