JSON-Surf
Search/Analyze JSON and Rust Struct
[](https://travis-ci.org/sgrust01/json-surf)
[](https://codecov.io/gh/sgrust01/json-surf)
[](https://blog.rust-lang.org/2020/05/07/Rust.1.43.1.html)
[](https://gitter.im/json-surf/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## Features
* Full Text/Term search (sqlish!!!)
* Easy read, write & delete API
* Serialize __**flat**__ JSON/Struct
* Write multiple documents together
* Support fuzzy word search (see examples)
* Requires no runtime
* No unsafe block
* Run on rust stable
* Coming Soon: Bi-gram suggestion & TF-IDF support
## Motivation
* Allow your existing flat rust structs to be searched
* The crate will support arbitary byte stream once it is supported by tantivy (see [here](https://github.com/tantivy-search/tantivy/issues/832))
* This can just act as a container to actual data in databases, keeping indexes light
* Create time-aware containers which could possibly updated/deleted
* Create ephemeral storage for request/response
* This can integrate with any web-server to index and search near real-time
* This crate will focus mostly on user-workflow(s) related problem(s)
* Uses [tantivy](https://github.com/tantivy-search/tantivy) under the hood.
## TODO
* Add more examples
* Remove any further copy
* Introduce more housekeeping API (If required)
## Quickstart
### Prerequisite:
```toml
[dependencies]
json-surf = "*"
```
### Example
```rust
use std::convert::TryFrom;
use std::hash::{Hash, Hasher};
use std::cmp::{Ord, Ordering, Eq};
use std::fs::remove_dir_all;
use serde::{Serialize, Deserialize};
use json_surf::prelude::*;
// Main struct
#[derive(Serialize, Debug, Deserialize, PartialEq, PartialOrd, Clone)]
struct UserInfo {
first: String,
last: String,
age: u8,
}
impl UserInfo {
pub fn new(first: String, last: String, age: u8) -> Self {
Self {
first,
last,
age,
}
}
}
impl Default for UserInfo {
fn default() -> Self {
let first = "".to_string();
let last = "".to_string();
let age = 0u8;
UserInfo::new(first, last, age)
}
}
fn main() {
// Specify home location for indexes
let home = ".store".to_string();
// Specify index name
let index_name = "usage".to_string();
// Prepare builder
let mut builder = SurferBuilder::default();
builder.set_home(&home);
let data = UserInfo::default();
builder.add_struct(index_name.clone(), &data);
// Prepare Surf
let mut surf = Surf::try_from(builder).unwrap();
// Prepare data to insert & search
// User 1: John Doe
let first = "John".to_string();
let last = "Doe".to_string();
let age = 20u8;
let john_doe = UserInfo::new(first, last, age);
// User 2: Jane Doe
let first = "Jane".to_string();
let last = "Doe".to_string();
let age = 18u8;
let jane_doe = UserInfo::new(first, last, age);
// See examples for more options
let users = vec![john_doe.clone(), jane_doe.clone()];
let _ = surf.insert(&index_name, &users).unwrap();
block_thread(1);
// See examples for more options
// Similar to SELECT * FROM users WHERE (age = 20 AND last = "Doe") OR (first = "Jane")
let conditions = vec![
OrCondition::new(
// (age = 20 AND last = "Doe")
vec![
AndCondition::new("age".to_string(), "20".to_string()),
AndCondition::new("last".to_string(), "doe".to_string())
]),
OrCondition::new(
// (first = "Jane")
vec![
AndCondition::new("first".to_string(), "jane".to_string())
])
];
// Validate John and Jane Doe
let mut computed = surf.select::