libhaystack 3.1.6

Rust implementation of the Haystack 4 data types, defs, filter, units, and encodings
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

// Copyright (C) 2020 - 2022, J2 Innovations

//!
//! C API for working with the [Time](crate::val::Time) type.
//!

use chrono::Timelike;

use super::err::new_error;
use crate::haystack::val::Value;

/// Get the hour of a [Time](crate::val::Time) [Value](crate::val::Value)
/// # Arguments
/// val A [Time](crate::val::Time) [Value](crate::val::Value)
/// # Returns
/// - value
/// - -1 (u32::MAX) if there was an error
/// # Example
/// ```rust
/// # use crate::libhaystack::val::Value;
/// # use crate::libhaystack::c_api::value::*;
/// # use crate::libhaystack::c_api::time::*;
/// # unsafe {
/// let val = haystack_value_make_time(12, 12, 59);
/// # let val = Box::<Value>::leak(val.unwrap());
/// assert!(haystack_value_is_time(val));
/// assert_eq!(haystack_value_get_time_hour(val), 12);
/// # }
/// ```
/// # Safety
/// Panics on invalid input data
#[unsafe(no_mangle)]
pub unsafe extern "C" fn haystack_value_get_time_hour(val: *const Value) -> u32 {
    match unsafe { val.as_ref() } {
        Some(value) => match value {
            Value::Time(time) => return time.hour(),
            _ => new_error("Not a Time Value"),
        },
        None => new_error("Invalid Value reference"),
    };
    u32::MAX
}

/// Get the minutes of a [Time](crate::val::Time) [Value](crate::val::Value)
/// # Arguments
/// val A [Time](crate::val::Time) [Value](crate::val::Value)
/// # Returns
/// - value
/// - -1 (u32::MAX) if there was an error
/// # Example
/// ```rust
/// # use crate::libhaystack::val::Value;
/// # use crate::libhaystack::c_api::value::*;
/// # use crate::libhaystack::c_api::time::*;
/// # unsafe {
/// let val = haystack_value_make_time(12, 15, 59);
/// # let val = Box::<Value>::leak(val.unwrap());
/// assert!(haystack_value_is_time(val));
/// assert_eq!(haystack_value_get_time_minutes(val), 15);
/// # }
/// ```
/// # Safety
/// Panics on invalid input data
#[unsafe(no_mangle)]
pub unsafe extern "C" fn haystack_value_get_time_minutes(val: *const Value) -> u32 {
    match unsafe { val.as_ref() } {
        Some(value) => match value {
            Value::Time(time) => return time.minute(),
            _ => new_error("Not a Time Value"),
        },
        None => new_error("Invalid Value reference"),
    };
    u32::MAX
}

/// Get the seconds of a [Time](crate::val::Time) [Value](crate::val::Value)
/// # Arguments
/// val A [Time](crate::val::Time) [Value](crate::val::Value)
/// # Returns
/// - value
/// - -1 (u32::MAX) if there was an error
/// # Example
/// ```rust
/// # use crate::libhaystack::val::Value;
/// # use crate::libhaystack::c_api::value::*;
/// # use crate::libhaystack::c_api::time::*;
/// # unsafe {
/// let val = haystack_value_make_time(12, 15, 59);
/// # let val = Box::<Value>::leak(val.unwrap());
/// assert!(haystack_value_is_time(val));
/// assert_eq!(haystack_value_get_time_seconds(val), 59);
/// # }
/// ```
/// # Safety
/// Panics on invalid input data
#[unsafe(no_mangle)]
pub unsafe extern "C" fn haystack_value_get_time_seconds(val: *const Value) -> u32 {
    match unsafe { val.as_ref() } {
        Some(value) => match value {
            Value::Time(time) => return time.second(),
            _ => new_error("Not a Time Value"),
        },
        None => new_error("Invalid Value reference"),
    };
    u32::MAX
}

/// Get the milliseconds of a [Time](crate::val::Time) [Value](crate::val::Value)
/// # Arguments
/// val A [Time](crate::val::Time) [Value](crate::val::Value)
/// # Returns
/// - value
/// - -1 (u32::MAX) if there was an error
/// # Example
/// ```rust
/// # use crate::libhaystack::val::Value;
/// # use crate::libhaystack::c_api::value::*;
/// # use crate::libhaystack::c_api::time::*;
/// # unsafe {
/// let val = haystack_value_make_time_millis(12, 15, 59, 999);
/// # let val = Box::<Value>::leak(val.unwrap());
/// assert!(haystack_value_is_time(val));
/// assert_eq!(haystack_value_get_time_millis(val), 999);
/// # }
/// ```
/// # Safety
/// Panics on invalid input data
#[unsafe(no_mangle)]
pub unsafe extern "C" fn haystack_value_get_time_millis(val: *const Value) -> u32 {
    match unsafe { val.as_ref() } {
        Some(value) => match value {
            Value::Time(time) => return time.nanosecond() / 1_000_000,
            _ => new_error("Not a Time Value"),
        },
        None => new_error("Invalid Value reference"),
    };
    u32::MAX
}