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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
// Copyright 2015 Axel Rasmussen
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![deny(
anonymous_parameters,
missing_docs,
trivial_casts,
trivial_numeric_casts,
unused_extern_crates,
unused_import_braces
)]
#![warn(bare_trait_objects, unreachable_pub, unused_qualifications)]
//! bdrck is a crate which contains some basic foundational tools. In general,
// the intent is to provide the kind of utilties which might be found in std
// some day, which are useful for most or all Rust programs.
/// Utilities for command-line interfaces.
#[cfg(feature = "cli")]
pub mod cli;
/// The configuration module contains utilities for persisting application
/// configuration to disk.
#[cfg(feature = "configuration")]
pub mod configuration;
/// crypto contains some basic cryptographic primitives, built largely on top of
/// NaCl, which are generally useful for any program which performs crypto ops.
#[cfg(feature = "crypto")]
pub mod crypto;
/// error defines error types specific to bdrck, which properly aggregates
/// errors from all of bdrck's dependencies.
pub mod error;
/// fs provides various utilities for interacting with the filesystem.
#[cfg(feature = "fs")]
pub mod fs;
/// http provides a really thin HTTP client wrapper around reqwest. The main
/// value-add is the addition of a mechanism for recording HTTP sessions, which
/// can be used for generating data for unit tests and then replaying it during
/// the test so we can verify the client's behavior given previously observed
/// server behavior.
#[cfg(feature = "http")]
pub mod http;
/// io provides additional small utilities on top of std::io.
#[cfg(feature = "io")]
pub mod io;
/// logging provides Logger implementations suitable for either command-line
/// applications or serving daemons.
#[cfg(feature = "logging")]
pub mod logging;
/// net provides additional network-related utilities, on top of what is
/// available in std.
#[cfg(feature = "net")]
pub mod net;
/// testing provides utilities which are useful for unit testing real production
/// code.
#[cfg(feature = "testing")]
pub mod testing;
// Tests have significantly more dependencies than the code being tested. Don't
// bother running tests unless all features are enabled.
#[cfg(all(
feature = "cli",
feature = "configuration",
feature = "crypto",
feature = "fs",
feature = "http",
feature = "logging",
feature = "net",
feature = "testing"
))]
#[cfg(test)]
mod tests;
use lazy_static::lazy_static;
lazy_static! {
static ref INIT_STATUS: ::std::sync::Mutex<bool> = ::std::sync::Mutex::new(false);
}
#[cfg(feature = "halite-sys")]
fn init_nacl() -> self::error::Result<()> {
if unsafe { halite_sys::sodium_init() } >= 0 {
Ok(())
} else {
Err(error::Error::Internal(format!(
"initializing cryptographic dependencies failed"
)))
}
}
#[cfg(not(feature = "halite-sys"))]
fn init_nacl() -> self::error::Result<()> {
Ok(())
}
/// This function must be called before calling any other library code, or else
/// undefined behavior (thread safety problems in particular) may result. This
/// is due to underlying C library dependencies.
pub fn init() -> self::error::Result<()> {
let mut lock = INIT_STATUS.lock().unwrap();
if *lock {
return Ok(());
}
init_nacl()?;
*lock = true;
Ok(())
}
/// Returns whether or not init() has been called.
pub fn init_done() -> bool {
*INIT_STATUS.lock().unwrap()
}