libeko 0.1.5

Create a command line interface binary with some common dependencies ((clap || docopt) and error_chain)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// Copyright (c) 2018 libeko developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

//! `libeko 0.1.0`
//!
//! `Echo` search and logging library for Kroger
#![deny(missing_docs)]
#[macro_use]
extern crate error_chain;
#[macro_use]
extern crate getset;
#[macro_use]
extern crate serde_derive;

extern crate curl;
extern crate serde;
extern crate serde_json;
extern crate uuid;

pub use echo::event::{Message, Type as MessageType};
pub use error::{Error, Result};
pub use sender::curl::Client;

mod echo;
mod error;
mod sender;

/// An `Echo Event` sender.
pub trait EchoEventClient {
    /// Send `Echo Event` messages.
    fn send_event(&mut self, messages: &[Message]) -> Result<()>;
}

/// An Echo search sender
pub trait EchoSearchClient {
    /// Send a search query.
    fn search(&mut self, search: &str) -> Result<String>;
    /// Send a scroll request.
    fn scroll(&mut self, scroll_id: &str) -> Result<String>;
}

/// Send `Echo Event` messages via the given event sender.
pub fn send_event(sender: &mut EchoEventClient, messages: &[Message]) -> Result<()> {
    sender.send_event(messages)
}

/// Send search via the given event sender.
pub fn search(sender: &mut EchoSearchClient, search: &str) -> Result<String> {
    sender.search(search)
}

/// Send a scroll request via the given event sender.
pub fn scroll(sender: &mut EchoSearchClient, scroll: &str) -> Result<String> {
    sender.scroll(scroll)
}