rfluids 0.3.1

🦀 Rusty CoolProp wrapper
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

//! Implementation of the `CoolProp` native API.
//!
//! This module provides Rust bindings and high-level abstractions for interacting
//! with the `CoolProp` thermophysical properties library.
//!
//! # Types
//!
//! The main types provided by this module are:
//!
//! - [`CoolProp`] -- high-level API for simplified access to properties
//! - [`AbstractState`] -- low-level API for direct control and improved performance

mod common;
mod high_level_api;
mod low_level_api;
mod utils;

pub use high_level_api::CoolProp;
pub use low_level_api::AbstractState;

/// `CoolProp` internal error.
#[derive(Clone, Debug, Eq, PartialEq, thiserror::Error)]
#[error("{0}")]
pub struct CoolPropError(pub(crate) String);

impl Default for CoolPropError {
    fn default() -> Self {
        Self("Unknown CoolProp error".into())
    }
}

/// A type alias for results returned by `CoolProp` native API.
pub type Result<T> = std::result::Result<T, CoolPropError>;

#[cfg(test)]
mod tests {
    use super::*;

    mod coolprop_error {
        use super::*;

        #[test]
        fn default() {
            // Given
            let sut = CoolPropError::default();

            // When
            let res = sut.to_string();

            // Then
            assert_eq!(res, "Unknown CoolProp error");
        }
    }
}