argonautica_c/
lib.rs

1//! [![Build Status](https://travis-ci.org/bcmyers/argonautica.svg?branch=master)](https://travis-ci.org/bcmyers/argonautica)
2//! [![Crates.io](https://img.shields.io/crates/v/argonautica-c.svg)](https://crates.io/crates/argonautica-c)
3//! [![Documentation](https://docs.rs/argonautica-c/badge.svg)](https://docs.rs/argonautica-c/)
4//! [![Github.com](https://img.shields.io/badge/github-bcmyers%2Fargonautica-blue.svg)](http://www.github.com/bcmyers/argonautica)
5//! ![License](https://img.shields.io/crates/l/argonautica-c.svg)
6//!
7//! # Overview
8//!
9//! [argonautica-c](https://github.com/bcmyers/argonautica/tree/master/argonautica-c)
10//! is a C/C++ wrapper for
11//! [argonautica](https://crates.io/crates/argonautica).
12//!
13//! # Installation
14//!
15//! * Install [Rust](https://www.rust-lang.org/en-US/) (version 1.26.0 or higher)
16//!     * See [here](https://rustup.rs/) for instructions
17//! * Install [LLVM/Clang](https://llvm.org/) (version 3.9 or higher)
18//!     * Mac OS: `brew install llvm`, which requires [Homebrew](https://brew.sh/)
19//!     * Debian-based linux: `apt-get install clang llvm-dev libclang-dev`
20//!     * Arch linux: `pacman -S clang`
21//!     * Windows: Download a pre-built binary [here](http://releases.llvm.org/download.html)
22//! * Clone the [argonautica repository](https://github.com/bcmyers/argonautica)
23//!     * `git clone https://github.com/bcmyers/argonautica.git`
24//!     * `cd argonautica`
25//!     * `git submodule init`
26//!     * `git submodule update`
27//! * Build the library using [Cargo](https://github.com/rust-lang/cargo)
28//!     * `cargo build --release --features="simd"`, or
29//!     * `cargo build --release`
30//! * Use the library
31//!     * The library, which will be called `libargonautica_c.dylib` or something similar (depending on your OS), will be in the `./target/release` directory
32//!     * The header file, which will be called `argonautica.h`, will be in the `./argonautica-c/include` directory
33//!
34//! # License
35//!
36//! <b>argonautica-c</b> is licensed under either of:
37//! * [The Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), or
38//! * [The MIT license](http://opensource.org/licenses/MIT)
39//!
40//! at your option.
41#![deny(
42    missing_debug_implementations, missing_docs, unused_imports, unused_unsafe, unused_variables
43)]
44#![doc(html_root_url = "https://docs.rs/argonautica-c/0.2.0")]
45
46extern crate argonautica;
47extern crate itoa;
48extern crate libc;
49
50mod error;
51mod hash;
52mod types;
53mod utils;
54mod verify;
55
56pub use error::*;
57pub use hash::*;
58pub use types::*;
59pub use utils::*;
60pub use verify::*;
argonautica_c/lib.rs

argonautica_c/
lib.rs
