Working support for current RediSearch version

Author: gavrie

.gitignore

@@ -10,3 +10,5 @@ Cargo.lock
 **/*.rs.bk
 
 /.idea
+src/raw/bindings.rs
+libredisearch.a

Cargo.toml

@@ -1,9 +1,12 @@
 [package]
-name = "redisearch-api-rs"
+name = "redisearch_api"
 version = "0.1.0"
 authors = ["Gavrie Philipson <gavrie@redislabs.com>"]
 edition = "2018"
 
+#links = "redisearch"
+#build = "build.rs"
+
 [[example]]
 name = "hello_redisearch"
 crate-type = ["cdylib"]
@@ -12,9 +15,10 @@ crate-type = ["cdylib"]
 bitflags = "1.1"
 libc = "0.2"
 time = "0.1"
-enum-primitive-derive = "^0.1"
-num-traits = "^0.2"
-#failure = "0.1"
+enum-primitive-derive = "0.1.2"
+num-traits = "0.2.8"
+
+redismodule = { path = "../redismodule-rs" }
 
 [build-dependencies]
 bindgen = "0.51"

README.md

@@ -1,8 +1,14 @@
 # redisearch-api-rs
-Rust RediSearch API binding
 
 ## Rust API for RediSearch
 
 TODO:
 
 - Use it from RedisDoc to index JSON docs
+
+## Building
+
+On macOS:
+- `brew install llvm`
+
+Make sure you have `libredisearch.a` built. This will be done automatically in the future.

build.rs

@@ -1,21 +1,41 @@
 extern crate bindgen;
 extern crate cc;
 
+use std::env;
+
 fn main() {
-    //    cc::Build::new()
-    //        .file("src/redisearch/redisearch_api.c")
-    //        //.include("src/include/") // For redismodule.h
-    //        .include("src/include/")
-    //        .compile("redisearch_api");
+    // Generate bindings for RediSearch
 
     let bindings = bindgen::Builder::default()
         .header("src/include/redisearch_api.h")
         //.clang_arg("-I src/include") // For redismodule.h
-        .whitelist_var("(RS|RediSearch).*")
+        .whitelist_var("(RS|RediSearch|REDISEARCH_|GC_POLICY).*")
+        .whitelist_function("RediSearch.*")
+        .blacklist_item("RedisModule.*")
+        .raw_line("use redismodule::raw::{RedisModuleCtx, RedisModuleString};")
         .generate()
         .expect("error generating RediSearch bindings");
 
     bindings
         .write_to_file("src/raw/bindings.rs")
         .expect("failed to write RediSearch bindings to file");
+
+    // Find and link statically to libredisearch.a
+
+    // TODO: Instead of relying on a pre-built library,
+    // we should build RediSearch as a static lib, like this:
+    //
+    //    mkdir -p build
+    //    cd build
+    //    cmake -DRS_BUILD_STATIC=ON ..
+    //    make
+    //
+    // Take a look at some `-sys` crates for system library wrappers, and build using the
+    // same methods that they use.
+    // In fact, consider splitting this crate into a `-sys` crate for the low level wrappers
+    // and another one for the high-level bindings.
+
+    let lib_search_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+    println!("cargo:rustc-link-search=native={}", lib_search_dir);
+    println!("cargo:rustc-link-lib=static=redisearch");
 }

examples/hello_redisearch.rs

@@ -0,0 +1,47 @@
+#[macro_use]
+extern crate redismodule;
+
+use redisearch_api::{self, init, Document, Index};
+use redismodule::{Context, NextArg, RedisError, RedisResult};
+
+fn hello_redisearch(_: &Context, args: Vec<String>) -> RedisResult {
+    let mut args = args.into_iter().skip(1);
+    let search_term = args.next_string()?;
+
+    // FT.CREATE my_index
+    //     SCHEMA
+    //         $a.b.c TEXT WEIGHT 5.0
+    //         $a.b.d TEXT
+    //         $b.a TEXT
+
+    // see RediSearch: t_llapi.cpp
+
+    let index_name = "index";
+    let field_name = "foo";
+    let score = 1.0;
+
+    let index = Index::create(index_name);
+    index.create_field(field_name);
+
+    let doc = Document::create("doc1", score);
+    doc.add_field(field_name, "bar");
+    index.add_document(&doc)?;
+
+    let doc2 = Document::create("doc2", score);
+    doc2.add_field(field_name, "quux");
+    index.add_document(&doc2)?;
+
+    let keys: Vec<_> = index.search(search_term.as_str())?.collect();
+
+    Ok(keys.into())
+}
+
+redis_module! {
+    name: "hello_redisearch",
+    version: 1,
+    data_types: [],
+    init: init,
+    commands: [
+        ["hello_redisearch", hello_redisearch, ""],
+    ],
+}

src/document.rs

@@ -0,0 +1,36 @@
+use std::ffi::CString;
+use std::os::raw::c_void;
+use std::ptr;
+
+use crate::raw;
+
+pub struct Document {
+    pub(crate) inner: *mut raw::RSDoc,
+}
+
+impl Document {
+    pub fn create(key: &str, score: f64) -> Self {
+        let c_key = CString::new(key).unwrap();
+        let lang = ptr::null(); // Default language
+
+        let doc = unsafe {
+            raw::RediSearch_CreateDocument(c_key.as_ptr() as *const c_void, key.len(), score, lang)
+        };
+
+        Self { inner: doc }
+    }
+
+    pub fn add_field(&self, name: &str, value: &str) {
+        let name = CString::new(name).unwrap();
+        let c_value = CString::new(value).unwrap();
+        unsafe {
+            raw::RediSearch_DocumentAddFieldString(
+                self.inner,
+                name.as_ptr(),
+                c_value.as_ptr(),
+                value.len(),
+                raw::RSFLDTYPE_FULLTEXT,
+            );
+        }
+    }
+}

src/include/redisearch_api.h

@@ -1,6 +1,7 @@
 #ifndef SRC_REDISEARCH_API_H_
 #define SRC_REDISEARCH_API_H_
 
+#include "redisearch_defines.h"
 #include "redismodule.h"
 #include <limits.h>
 
@@ -16,6 +17,12 @@ extern "C" {
 #define MODULE_API_FUNC(T, N) T N
 #endif
 
+/*
+MODULE_API_FUNC(int, RediSearch_GetCApiVersion)();
+int RediSearch_GetCApiVersion)();
+extern int (*RediSearch_GetCApiVersion)();
+*/
+
 typedef struct IndexSpec RSIndex;
 typedef size_t RSFieldID;
 #define RSFIELD_INVALID SIZE_MAX

src/include/redisearch_defines.h

@@ -0,0 +1 @@
+#define REDISMODULE_EXPERIMENTAL_API

src/include/redismodule.h

@@ -1,4 +1,4 @@
-#ifndef REDISMODULE_H
+ #ifndef REDISMODULE_H
 #define REDISMODULE_H
 
 #include <sys/types.h>
@@ -134,7 +134,8 @@ typedef struct RedisModuleTypeMethods {
   RedisModuleTypeFreeFunc free;
 } RedisModuleTypeMethods;
 
-#define REDISMODULE_API_FUNC(T, N) extern T(*N)
+//#define REDISMODULE_API_FUNC(T, N) extern T(*N)
+#define REDISMODULE_API_FUNC(T, N) T(*N)
 
 REDISMODULE_API_FUNC(int, RedisModule_GetApi)(const char *, void *);
 REDISMODULE_API_FUNC(void *, RedisModule_Alloc)(size_t bytes);