sdecay 0.1.0

Bindings for SandiaDecay C++ library, used to compute nuclide mixtures
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
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

#![doc = include_str!(join_path!("..", "README.md"))]
#![cfg_attr(
    not(test),
    forbid(clippy::undocumented_unsafe_blocks, clippy::missing_safety_doc)
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(all(not(test), not(feature = "std")), no_std)]

#[macro_use]
extern crate pathsep;

// -- FOLLOWING MODULES DO CONTAIN UNSAFE CODE --
pub mod wrapper;

pub mod container;

// -- REST OF THE MODULES ARE MARKED WITH `#[forbid(unsafe)]` --

#[doc = include_str!(join_path!("..", "SAFETY.md"))]
#[forbid(unsafe_code)]
pub mod safety {}

#[doc = include_str!(join_path!("..", "BUILDING.md"))]
#[forbid(unsafe_code)]
pub mod building {}

#[doc = include_str!(join_path!("..", "SAFETY.md"))]
#[forbid(unsafe_code)]
pub mod features {}

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

pub use paste::paste;

#[macro_use]
extern crate sdecay_nolt;
#[macro_use]
extern crate thiserror;

#[forbid(unsafe_code)]
mod macros;
use macros::{
    containers, ffi_unwrap_or, forward_pin_mut_call, impl_moveable, vec_wrapper, wrapper,
};

/// Constants defining `Sandia Decay`'s unit system.
///
/// ### Examples
/// 5 seconds:
/// ```rust
/// # use sdecay::cst::second;
/// let _ = 5.0 * second;
/// ```
///
/// 3e7 Bq:
/// ```rust
/// # use sdecay::cst::Bq;
/// let _ = 3.0e7 * Bq;
/// ```
///
/// etc
#[forbid(unsafe_code)]
pub mod cst {
    pub use sdecay_sys::sandia_decay::{
        Bq, Ci, MBq, MeV, becquerel, cm, cm2, cm3, curie, day, eV, hour, keV, m, meter, mm, month,
        second, year,
    };
}

#[forbid(unsafe_code)]
pub mod database;
#[cfg(feature = "alloc")]
pub use database::{Database, SharedDatabase, UninitDatabase, UninitSharedDatabase};
pub use database::{LocalDatabase, UninitLocalDatabase};

#[forbid(unsafe_code)]
pub mod nuclide_mixture;
pub use nuclide_mixture::LocalMixture;
#[cfg(feature = "alloc")]
pub use nuclide_mixture::Mixture;

#[forbid(unsafe_code)]
pub mod add_nuclide_spec;

#[forbid(unsafe_code)]
pub mod element_spec;

#[forbid(unsafe_code)]
pub mod nuclide_spec;

#[forbid(unsafe_code)]
pub mod as_cpp_string;

#[cfg(test)]
mod tests;