#lucene #query #builder #derive #ignore #proc-macro #attribute-macro #struct #field

lucene_query_builder

A procmacro derive crate to generate lucene query builder for Rust structs :

7 releases

0.3.0 Jul 14, 2021
0.2.4 Mar 11, 2021
0.2.2 Dec 18, 2019
0.1.0 Dec 12, 2019

#792 in Rust patterns

Download history 17/week @ 2022-11-28 33/week @ 2022-12-05 34/week @ 2022-12-12 38/week @ 2022-12-19 21/week @ 2022-12-26 25/week @ 2023-01-02 40/week @ 2023-01-09 33/week @ 2023-01-16 41/week @ 2023-01-23 39/week @ 2023-01-30 25/week @ 2023-02-06 46/week @ 2023-02-13 47/week @ 2023-02-20 6/week @ 2023-02-27 30/week @ 2023-03-06 53/week @ 2023-03-13

142 downloads per month
Used in 2 crates

MIT license

4KB

Lucene Query Builder Derive

A procmacro derive crate to generate lucene query builder for Rust structs :

Usage :

use lucene_query_builder::QueryBuilder;

#[derive(QueryBuilder)]
struct Person {
    name: String,
    age: i32,
}

Simple query

let query = Person::query_builder()
    .name("Bob")
    .or()
    .name("Alice")
    .build();

assert_eq!(query, "query=name:Bob OR name:Alice".to_string());

Nested query

let query = Person::query_builder()
    .expr(Person::query_builder().name("Bob").or().name("Alice"))
    .and()
    .age("22")
    .build();

assert_eq!(
    query,
    "query=(name:Bob OR name:Alice) AND age:22".to_string()
);

Range query

let query = Person::query_builder().age_range("7", "77").build();

assert_eq!(query, "query=age:[7 TO 77]".to_string());

Rename builder functions and field names

Use #[query_builder_rename = "name"] if you need to rename the generated method :

#[derive(QueryBuilder)]
struct Person {
    name: String,
    age: i32,
    #[query_builder_rename = "fullname"]
    complete_name: String,
}
let query = Person::query_builder()
    .name("Bob")
    .and()
    .fullname("Bob Marley")
    .build();

assert_eq!(
    query,
    "query=name:Bob AND complete_name:\"Bob Marley\"".to_string()
);

If you need to rename the generated lucene field you can use #[query_builder_field = "name"].

#[derive(QueryBuilder)]
struct Person {
    name: String,
    age: i32,
    #[query_builder_rename = "fullname"]
    #[query_builder_field = "fullname"]
    complete_name: String,
}
let query = Person::query_builder()
    .name("Bob")
    .and()
    .fullname("Bob Marley")
    .build();

assert_eq!(
    query,
    "query=name:Bob AND fullname:\"Bob Marley\"".to_string()
);

Ignore fields

If you need to ignore a field use the attribute macro : #[query_builder_ignore]

Dependencies

~0.6–1MB
~26K SLoC