Export EosVariant and FunctionalVariant at the crate root

prehner · prehner · commit 4d5a14744171 · 2022-10-18T13:51:47.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- Export `EosVariant` and `FunctionalVariant` directly in the crate root instead of their own modules. [#62](https://github.com/feos-org/feos/pull/62)
 
 ## [0.3.0] - 2022-09-14
 - Major restructuring of the entire `feos` project. All individual models are reunited in the `feos` crate. `feos-core` and `feos-dft` still live as individual crates within the `feos` workspace.
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,7 @@ keywords = ["physics", "thermodynamics", "equations_of_state", "phase_equilibria
 categories = ["science"]
 
 [package.metadata.docs.rs]
-features = ["all_models"]
+features = ["all_models", "rayon"]
 rustdoc-args = [ "--html-in-header", "./docs-header.html" ]
 
 [workspace]
diff --git a/feos-core/Cargo.toml b/feos-core/Cargo.toml
@@ -15,6 +15,7 @@ workspace = ".."
 
 [package.metadata.docs.rs]
 rustdoc-args = [ "--html-in-header", "./docs-header.html" ]
+features = "rayon"
 
 [dependencies]
 quantity = "0.5"
diff --git a/src/dft.rs b/src/dft.rs
@@ -15,6 +15,10 @@ use petgraph::graph::UnGraph;
 use petgraph::Graph;
 use quantity::si::*;
 
+/// Collection of different [HelmholtzEnergyFunctional] implementations.
+///
+/// Particularly relevant for situations in which generic types
+/// are undesirable (e.g. FFI).
 #[derive(HelmholtzEnergyFunctional)]
 pub enum FunctionalVariant {
     #[cfg(feature = "pcsaft")]
diff --git a/src/eos.rs b/src/eos.rs
@@ -14,6 +14,10 @@ use feos_derive::EquationOfState;
 use ndarray::Array1;
 use quantity::si::*;
 
+/// Collection of different [EquationOfState] implementations.
+///
+/// Particularly relevant for situations in which generic types
+/// are undesirable (e.g. FFI).
 #[derive(EquationOfState)]
 pub enum EosVariant {
     #[cfg(feature = "pcsaft")]
diff --git a/src/lib.rs b/src/lib.rs
@@ -34,8 +34,11 @@
 #![warn(clippy::all)]
 #![allow(clippy::too_many_arguments)]
 #[cfg(feature = "dft")]
-pub mod dft;
-pub mod eos;
+mod dft;
+#[cfg(feature = "dft")]
+pub use dft::FunctionalVariant;
+mod eos;
+pub use eos::EosVariant;
 
 #[cfg(feature = "estimator")]
 pub mod estimator;
