clam_client/lib.rs
1#![deny(missing_docs)]
2
3//! # clam_client - a client implementation for ClamAV written in Rust.
4//! `clam_client`, provides a simple interface to all basic ClamAV functionality, currently
5//! the only thing missing is sessions/multi threaded scanning, which may or may not be added
6//! depending on demand.
7//!
8//! ## Example
9//! ```rust
10//! extern crate clam_client;
11//! use clam_client::client::ClamClient;
12//! use std::env;
13//!
14//! fn main() {
15//! if let Some(path) = env::args().nth(1) {
16//! let client = ClamClient::new("127.0.0.1", 3310).unwrap();
17//! println!(
18//! "Scan for '{}':\n\t{:?}\n",
19//! path,
20//! client.scan_path(&path, true).unwrap()
21//! );
22//! } else {
23//! println!("USAGE: cargo run --example simple \"<file_path>\"");
24//! }
25//! }
26//! ```
27//!
28
29#[cfg(feature = "serde")]
30#[macro_use]
31extern crate serde;
32
33#[macro_use]
34extern crate failure;
35#[macro_use]
36extern crate nom;
37
38extern crate byteorder;
39extern crate chrono;
40
41pub mod client;
42pub mod error;
43pub mod response;