Struct json_surf::registry::Surfer

pub struct Surfer { /* fields omitted */ }

Surfer: Client API

Implementations

impl Surfer

pub fn home(&self) -> &String

Location of home

pub fn which_index(&self, name: &str) -> Option<String>

Location of Index

pub fn insert_struct<T: Serialize>(
    &mut self,
    name: &str,
    data: &T
) -> Result<(), IndexError>

Inserts a struct

pub fn insert_structs<T: Serialize>(
    &mut self,
    name: &str,
    payload: &Vec<T>
) -> Result<(), IndexError>

Inserts a structs

pub fn read_string(
    &mut self,
    name: &str,
    query: &str,
    limit: Option<usize>,
    score: Option<f32>
) -> Result<Option<Vec<String>>, IndexError>

Reads as string

pub fn read_structs<T: Serialize + DeserializeOwned>(
    &mut self,
    name: &str,
    query: &str,
    limit: Option<usize>,
    score: Option<f32>
) -> Result<Option<Vec<T>>, IndexError>

Reads as struct

impl Surfer

Panics if somethings goes wrong

pub fn new(builder: SurferBuilder) -> Self

Trait Implementations

impl TryFrom<SurferBuilder> for Surfer

type Error = IndexError

The type returned in the event of a conversion error.

fn try_from(builder: SurferBuilder) -> Result<Self, Self::Error>

Performs the conversion.