nautilus_core/ffi/
datetime.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 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//! Thin FFI wrappers around the date/time conversion utilities in `nautilus-core`.
17//!
18//! The Rust implementation already lives in `crate::datetime`; this module simply exposes the
19//! conversions to C (and, by extension, to Python via Cython) while keeping the behaviour and the
20//! documentation in one place.  Each exported function forwards directly to its Rust counterpart
21//! and therefore inherits the same semantics and safety guarantees.
22
23use std::ffi::c_char;
24
25use crate::{
26    datetime::{unix_nanos_to_iso8601, unix_nanos_to_iso8601_millis},
27    ffi::{abort_on_panic, string::str_to_cstr},
28};
29
30/// Converts a UNIX nanoseconds timestamp to an ISO 8601 (RFC 3339) format C string pointer.
31#[cfg(feature = "ffi")]
32#[unsafe(no_mangle)]
33pub extern "C" fn unix_nanos_to_iso8601_cstr(timestamp_ns: u64) -> *const c_char {
34    abort_on_panic(|| str_to_cstr(&unix_nanos_to_iso8601(timestamp_ns.into())))
35}
36
37/// Converts a UNIX nanoseconds timestamp to an ISO 8601 (RFC 3339) format C string pointer
38/// with millisecond precision.
39#[cfg(feature = "ffi")]
40#[unsafe(no_mangle)]
41pub extern "C" fn unix_nanos_to_iso8601_millis_cstr(timestamp_ns: u64) -> *const c_char {
42    abort_on_panic(|| str_to_cstr(&unix_nanos_to_iso8601_millis(timestamp_ns.into())))
43}
44
45/// Converts seconds to nanoseconds (ns).
46#[cfg(feature = "ffi")]
47#[unsafe(no_mangle)]
48pub extern "C" fn secs_to_nanos(secs: f64) -> u64 {
49    abort_on_panic(|| crate::datetime::secs_to_nanos_unchecked(secs))
50}
51
52/// Converts seconds to milliseconds (ms).
53#[cfg(feature = "ffi")]
54#[unsafe(no_mangle)]
55pub extern "C" fn secs_to_millis(secs: f64) -> u64 {
56    abort_on_panic(|| {
57        crate::datetime::secs_to_millis(secs).expect("secs_to_millis: invalid or overflowing input")
58    })
59}
60
61/// Converts milliseconds (ms) to nanoseconds (ns).
62#[cfg(feature = "ffi")]
63#[unsafe(no_mangle)]
64pub extern "C" fn millis_to_nanos(millis: f64) -> u64 {
65    abort_on_panic(|| crate::datetime::millis_to_nanos_unchecked(millis))
66}
67
68/// Converts microseconds (μs) to nanoseconds (ns).
69#[cfg(feature = "ffi")]
70#[unsafe(no_mangle)]
71pub extern "C" fn micros_to_nanos(micros: f64) -> u64 {
72    abort_on_panic(|| crate::datetime::micros_to_nanos_unchecked(micros))
73}
74
75/// Converts nanoseconds (ns) to seconds.
76#[cfg(feature = "ffi")]
77#[unsafe(no_mangle)]
78pub extern "C" fn nanos_to_secs(nanos: u64) -> f64 {
79    abort_on_panic(|| crate::datetime::nanos_to_secs(nanos))
80}
81
82/// Converts nanoseconds (ns) to milliseconds (ms).
83#[cfg(feature = "ffi")]
84#[unsafe(no_mangle)]
85pub extern "C" fn nanos_to_millis(nanos: u64) -> u64 {
86    abort_on_panic(|| crate::datetime::nanos_to_millis(nanos))
87}
88
89/// Converts nanoseconds (ns) to microseconds (μs).
90#[cfg(feature = "ffi")]
91#[unsafe(no_mangle)]
92pub extern "C" fn nanos_to_micros(nanos: u64) -> u64 {
93    abort_on_panic(|| crate::datetime::nanos_to_micros(nanos))
94}