rfluids 0.4.0

🦀 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

//! 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` error.
#[derive(Clone, Debug, Eq, PartialEq, thiserror::Error)]
#[non_exhaustive]
pub enum CoolPropError {
    /// Error reported by `CoolProp`.
    #[error("{0}")]
    Native(String),

    /// Non-finite result returned by `CoolProp` without an error message.
    #[error("CoolProp returned a non-finite output without an error message")]
    NonFiniteOutput,

    /// Non-finite keyed output returned by `CoolProp` without an error message.
    #[error("CoolProp returned a non-finite output for key `{key}` without an error message")]
    NonFiniteKeyedOutput {
        /// Requested output key.
        key: u8,
    },

    /// Input string cannot be represented as a C string because it contains an interior NUL byte.
    #[error("input `{arg}` contains an interior NUL byte at byte position {pos}")]
    InteriorNul {
        /// Name of the invalid input argument.
        arg: &'static str,
        /// Byte position of the interior NUL byte.
        pos: usize,
    },
}

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