Skip to main content

nautilus_infrastructure/sql/models/
mod.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! SQL database row and value mappings.
17
18use std::fmt::Display;
19
20use nautilus_model::types::Money;
21use sqlx::{Row, postgres::PgRow};
22
23pub mod accounts;
24pub mod data;
25pub mod enums;
26pub mod general;
27pub mod instruments;
28pub mod orders;
29pub mod positions;
30pub mod types;
31
32pub(crate) fn read_u8(row: &PgRow, column: &str) -> Result<u8, sqlx::Error> {
33    let value = row.try_get::<i32, _>(column)?;
34    i32_to_u8(value, column)
35}
36
37pub(crate) fn read_u16(row: &PgRow, column: &str) -> Result<u16, sqlx::Error> {
38    let value = row.try_get::<i32, _>(column)?;
39    i32_to_u16(value, column)
40}
41
42pub(crate) fn read_usize(row: &PgRow, column: &str) -> Result<usize, sqlx::Error> {
43    let value = row.try_get::<i32, _>(column)?;
44    i32_to_usize(value, column)
45}
46
47pub(crate) fn read_u64(row: &PgRow, column: &str) -> Result<u64, sqlx::Error> {
48    let value = row.try_get::<i64, _>(column)?;
49    i64_to_u64(value, column)
50}
51
52pub(crate) fn i64_to_u64(value: i64, label: &str) -> Result<u64, sqlx::Error> {
53    u64::try_from(value).map_err(|e| decode_error(label, value, e))
54}
55
56pub(crate) fn decode_money(value: &str, label: &str) -> Result<Money, sqlx::Error> {
57    Money::from_str_exact(value).map_err(|e| decode_error(label, value, e))
58}
59
60fn i32_to_u8(value: i32, label: &str) -> Result<u8, sqlx::Error> {
61    u8::try_from(value).map_err(|e| decode_error(label, value, e))
62}
63
64fn i32_to_u16(value: i32, label: &str) -> Result<u16, sqlx::Error> {
65    u16::try_from(value).map_err(|e| decode_error(label, value, e))
66}
67
68fn i32_to_usize(value: i32, label: &str) -> Result<usize, sqlx::Error> {
69    usize::try_from(value).map_err(|e| decode_error(label, value, e))
70}
71
72fn decode_error(label: &str, value: impl Display, error: impl Display) -> sqlx::Error {
73    sqlx::Error::Decode(format!("Invalid {label} value {value}: {error}").into())
74}
75
76#[cfg(test)]
77mod tests {
78    use rstest::rstest;
79
80    use super::{i32_to_u8, i32_to_u16, i32_to_usize, i64_to_u64};
81
82    #[rstest]
83    #[case::negative(-1, "Invalid price_precision value -1")]
84    #[case::too_large(i32::from(u8::MAX) + 1, "Invalid price_precision value 256")]
85    fn i32_to_u8_rejects_out_of_range(#[case] value: i32, #[case] expected: &str) {
86        let error = i32_to_u8(value, "price_precision").unwrap_err();
87
88        assert_decode_error_contains(&error, expected);
89    }
90
91    #[rstest]
92    #[case::negative(-1, "Invalid iso4217 value -1")]
93    #[case::too_large(i32::from(u16::MAX) + 1, "Invalid iso4217 value 65536")]
94    fn i32_to_u16_rejects_out_of_range(#[case] value: i32, #[case] expected: &str) {
95        let error = i32_to_u16(value, "iso4217").unwrap_err();
96
97        assert_decode_error_contains(&error, expected);
98    }
99
100    #[rstest]
101    fn i32_to_usize_rejects_negative_values() {
102        let error = i32_to_usize(-1, "step").unwrap_err();
103
104        assert_decode_error_contains(&error, "Invalid step value -1");
105    }
106
107    #[rstest]
108    fn i64_to_u64_rejects_negative_values() {
109        let error = i64_to_u64(-1, "duration_ns").unwrap_err();
110
111        assert_decode_error_contains(&error, "Invalid duration_ns value -1");
112    }
113
114    fn assert_decode_error_contains(error: &sqlx::Error, expected: &str) {
115        assert!(matches!(error, sqlx::Error::Decode(_)));
116        assert!(error.to_string().contains(expected));
117    }
118}