rlay-backend 0.3.0

Common traits for Rlay (storage) backends
Documentation
use ambassador::delegatable_trait;
use cid::Cid;
use failure::{err_msg, Error};
use futures::future::{err, BoxFuture, FutureExt};
use rlay_ontology::ontology::Entity;
use serde_json::Value;
use std::collections::HashMap;

#[delegatable_trait]
pub trait BackendRpcMethodGetEntity {
    #[allow(unused_variables)]
    fn get_entity(&mut self, cid: &str) -> BoxFuture<Result<Option<Entity>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodGetEntities {
    #[allow(unused_variables)]
    fn get_entities(&mut self, cids: Vec<String>) -> BoxFuture<Result<Vec<Entity>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodStoreEntity {
    #[allow(unused_variables)]
    fn store_entity(
        &mut self,
        entity: &Entity,
        options_object: &Value,
    ) -> BoxFuture<Result<Cid, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodStoreEntities {
    #[allow(unused_variables)]
    fn store_entities(
        &mut self,
        entities: &Vec<Entity>,
        options_object: &Value,
    ) -> BoxFuture<Result<Vec<Cid>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodListCids {
    #[allow(unused_variables)]
    fn list_cids(&mut self, entity_kind: Option<&str>) -> BoxFuture<Result<Vec<String>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodNeo4jQuery {
    #[allow(unused_variables)]
    fn neo4j_query(&mut self, query: &str) -> BoxFuture<Result<Vec<String>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodResolveEntity {
    #[allow(unused_variables)]
    fn resolve_entity(
        &mut self,
        cid: &str,
    ) -> BoxFuture<Result<HashMap<String, Vec<Entity>>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

#[delegatable_trait]
pub trait BackendRpcMethodResolveEntities {
    #[allow(unused_variables)]
    fn resolve_entities(
        &mut self,
        cids: Vec<String>,
    ) -> BoxFuture<Result<HashMap<String, Vec<Entity>>, Error>> {
        err(err_msg(
            "The requested backend does not support this RPC method.",
        ))
        .boxed()
    }
}

pub trait BackendRpcMethods:
    Send
    + BackendRpcMethodGetEntity
    + BackendRpcMethodGetEntities
    + BackendRpcMethodStoreEntity
    + BackendRpcMethodStoreEntities
    + BackendRpcMethodResolveEntity
    + BackendRpcMethodResolveEntities
    + BackendRpcMethodListCids
    + BackendRpcMethodNeo4jQuery
{
}