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 2017 Peter Williams
// Licensed under the MIT License.

/*!

Core types and concepts of the Rubbl framework.

This crate provides low-level types that are expected to be used throughout
the Rubbl framework.

*/

#![deny(missing_docs)]

extern crate byteorder;
extern crate clap;
extern crate failure;
#[macro_use]
extern crate failure_derive;
extern crate ndarray;
extern crate num_complex;
extern crate termcolor;

// convenience re-exports -- these can make it so that you can skip putting
// these crates in your Cargo.toml and the `extern crate` line in the toplevel
// of your crate.
pub use failure::{Error, Fail, ResultExt};
pub use ndarray::Array;
pub use num_complex::Complex;

/// A “contextualized try” macro.
///
/// Attempts an operation that returns a Result and returns its Ok value if
/// the operation is successful. If not, it returns an Err value of type
/// `failure::Context` that includes explanatory text formatted using the
/// `format!` macro and chains to the causative error. Example:
///
/// ```rust,ignore
/// ctry!(write!(myfile, "hello"); "couldn\'t write to {}", myfile_path);
/// ```
///
/// Note that the operation to be attempted and the arguments to `format!` are
/// separated by a semicolon within the `ctry!()` parentheses.
#[macro_export]
macro_rules! ctry {
    ($op:expr ; $( $chain_fmt_args:expr ),*) => {
        {
            use $crate::ResultExt;
            $op.with_context(|_| format!($( $chain_fmt_args ),*))?
        }
    }
}

pub mod io;
pub mod notify;
pub mod num;

/// A convenience Result type whose error half is fixed to be
/// `failure::Error`.
pub type Result<T> = ::std::result::Result<T, failure::Error>;