kdb_codec 1.1.0

Kdb+ IPC codec library for handling kdb+ wire protocol data with Rust.
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
//! Q null, infinity and negative infinity constants.

use crate::qconsts::{qinf_base, qninf_base, qnull_base};

pub mod qnull {
    //! This module provides a list of q null values set on Rust process and used for IPC. The motivation
    //!  to contain them in a module is to tie them up as related items rather than scattered values.
    //!  Hence user should use these indicators with `qnull::` prefix, e.g., `qnull::FLOAT`.

    use super::qnull_base;
    use chrono::prelude::*;
    use chrono::Duration;
    use once_cell::sync::Lazy;

    /// Null value of GUID (`0Ng`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_guid_null = K::new_guid(qnull::GUID);
    ///     assert_eq!(
    ///         format!("{}", q_guid_null),
    ///         String::from("00000000-0000-0000-0000-000000000000")
    ///     );
    /// }
    /// ```
    pub const GUID: [u8; 16] = [0_u8; 16];

    /// Null value of short (`0Nh`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_short_null = K::new_short(qnull::SHORT);
    ///     assert_eq!(format!("{}", q_short_null), String::from("0Nh"));
    /// }
    /// ```
    pub const SHORT: i16 = qnull_base::H;

    /// Null value of int (`0Ni`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_int_null = K::new_int(qnull::INT);
    ///     assert_eq!(format!("{}", q_int_null), String::from("0Ni"));
    /// }
    /// ```
    pub const INT: i32 = qnull_base::I;

    /// Null value of long (`0N`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_long_null = K::new_long(qnull::LONG);
    ///     assert_eq!(format!("{}", q_long_null), String::from("0N"));
    /// }
    /// ```
    pub const LONG: i64 = qnull_base::J;

    /// Null value of real (`0Ne`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_real_null = K::new_real(qnull::REAL);
    ///     assert_eq!(format!("{}", q_real_null), String::from("0Ne"));
    /// }
    /// ```
    pub const REAL: f32 = qnull_base::E;

    /// Null value of float (`0n`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_float_null = K::new_float(qnull::FLOAT);
    ///     assert_eq!(format!("{}", q_float_null), String::from("0n"));
    /// }
    /// ```
    pub const FLOAT: f64 = qnull_base::F;

    /// Null value of char (`" "`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_char_null = K::new_char(qnull::CHAR);
    ///     assert_eq!(format!("{}", q_char_null), String::from("\" \""));
    /// }
    /// ```
    pub const CHAR: char = qnull_base::C;

    /// Null value of symbol (<code>`</code>).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_symbol_null = K::new_symbol(qnull::SYMBOL);
    ///     assert_eq!(format!("{}", q_symbol_null), String::from("`"));
    /// }
    /// ```
    pub const SYMBOL: String = String::new();

    /// Null value of timestamp (`0Np`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timestamp_null = K::new_timestamp(*qnull::TIMESTAMP);
    ///     assert_eq!(format!("{}", q_timestamp_null), String::from("0Np"));
    /// }
    /// ```
    /// # Note
    /// The range of timestamp in Rust is wider than in q.
    pub const TIMESTAMP: Lazy<DateTime<Utc>> = Lazy::new(|| {
        NaiveDate::from_ymd_opt(1707, 9, 22)
            .unwrap()
            .and_hms_nano_opt(0, 12, 43, 145224192)
            .unwrap()
            .and_local_timezone(Utc)
            .unwrap()
    });

    /// Null value of month (`0Nm`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_month_null = K::new_month(qnull::MONTH);
    ///     assert_eq!(format!("{}", q_month_null), String::from("0Nm"));
    /// }
    /// ```
    /// # Note
    /// The range of month in Rust is narrower than in q.
    pub const MONTH: NaiveDate = NaiveDate::MIN;

    /// Null valueo of date (`0Nd`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_date_null = K::new_date(qnull::DATE);
    ///     assert_eq!(format!("{}", q_date_null), String::from("0Nd"));
    /// }
    /// ```
    /// # Note
    /// The range of date in Rust is narrower than in q.
    pub const DATE: NaiveDate = NaiveDate::MIN;

    /// Null value of datetime (`0Nz`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_datetime_null = K::new_datetime(qnull::DATETIME);
    ///     assert_eq!(format!("{}", q_datetime_null), String::from("0Nz"));
    /// }
    /// ```
    /// # Note
    /// The range of datetime in Rust is narrower than in q.
    pub const DATETIME: DateTime<Utc> = DateTime::<Utc>::MIN_UTC;

    /// Null value of timespan (`0Nn`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timespan_null = K::new_timespan(*qnull::TIMESPAN);
    ///     assert_eq!(format!("{}", q_timespan_null), String::from("0Nn"));
    /// }
    /// ```
    pub const TIMESPAN: Lazy<Duration> = Lazy::new(|| Duration::nanoseconds(qnull_base::J));

    /// Null value of minute (`0Nu`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_minute_null = K::new_minute(*qnull::MINUTE);
    ///     assert_eq!(format!("{}", q_minute_null), String::from("0Nu"));
    /// }
    /// ```
    pub const MINUTE: Lazy<Duration> = Lazy::new(|| Duration::minutes(qnull_base::I as i64));

    /// Null value of second (`0Nv`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_second_null = K::new_second(*qnull::SECOND);
    ///     assert_eq!(format!("{}", q_second_null), String::from("0Nv"));
    /// }
    /// ```
    pub const SECOND: Lazy<Duration> = Lazy::new(|| Duration::seconds(qnull_base::I as i64));

    /// Null value of time (`0Nt`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_time_null = K::new_time(*qnull::TIME);
    ///     assert_eq!(format!("{}", q_time_null), String::from("0Nt"));
    /// }
    /// ```
    pub const TIME: Lazy<Duration> = Lazy::new(|| Duration::milliseconds(qnull_base::I as i64));
}

pub mod qinf {
    //! This module provides a list of q infinite values set on Rust process and used for IPC.
    //!  The motivation to contain them in a module is to tie them up as related items rather
    //!  than scattered values. Hence user should use these indicators with `qnull::` prefix, e.g., `qnull::FLOAT`.

    use super::qinf_base;
    use chrono::prelude::*;
    use chrono::Duration;
    use once_cell::sync::Lazy;

    /// Infinity value of short (`0Wh`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_short_inf = K::new_short(qinf::SHORT);
    ///     assert_eq!(format!("{}", q_short_inf), String::from("0Wh"));
    /// }
    /// ```
    pub const SHORT: i16 = qinf_base::H;

    /// Infinity value of int (`0Wi`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_int_inf = K::new_int(qinf::INT);
    ///     assert_eq!(format!("{}", q_int_inf), String::from("0Wi"));
    /// }
    /// ```
    pub const INT: i32 = qinf_base::I;

    /// Infinity value of long (`0W`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_long = K::new_long(86400000000000);
    ///     assert_eq!(format!("{}", q_long), String::from("86400000000000"));
    /// }
    /// ```
    pub const LONG: i64 = qinf_base::J;

    /// Infinity value of real (`0We`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_real_null = K::new_real(qnull::REAL);
    ///     assert_eq!(format!("{}", q_real_null), String::from("0Ne"));
    /// }
    /// ```
    pub const REAL: f32 = qinf_base::E;

    /// Infinity value of float (`0w`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_float_inf = K::new_float(qinf::FLOAT);
    ///     assert_eq!(format!("{}", q_float_inf), String::from("0w"));
    /// }
    /// ```
    pub const FLOAT: f64 = qinf_base::F;

    /// Infinity value of timestamp (`0Wp`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timestamp_inf = K::new_timestamp(*qinf::TIMESTAMP);
    ///     assert_eq!(format!("{}", q_timestamp_inf), String::from("0Wp"));
    /// }
    /// ```
    /// # Note
    /// The range of timestamp in Rust is wider than in q.
    pub const TIMESTAMP: Lazy<DateTime<Utc>> = Lazy::new(|| {
        NaiveDate::from_ymd_opt(2292, 4, 10)
            .unwrap()
            .and_hms_nano_opt(23, 47, 16, 854775807)
            .unwrap()
            .and_local_timezone(Utc)
            .unwrap()
    });

    /// Infinity value of month (`0Wm`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_month_inf = K::new_month(*qinf::MONTH);
    ///     assert_eq!(format!("{}", q_month_inf), String::from("0Wm"));
    /// }
    /// ```
    /// # Note
    /// The range of month in Rust is narrower than in q.
    pub const MONTH: Lazy<NaiveDate> = Lazy::new(|| NaiveDate::MAX - Duration::days(30));

    /// Infinity valueo of date (`0Wd`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_date_inf = K::new_date(qinf::DATE);
    ///     assert_eq!(format!("{}", q_date_inf), String::from("0Wd"));
    /// }
    /// ```
    /// # Note
    /// The range of date in Rust is narrower than in q.
    pub const DATE: NaiveDate = NaiveDate::MAX;

    /// Infinity value of datetime (`0Wz`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_datetime_inf = K::new_datetime(*qinf::DATETIME);
    ///     assert_eq!(format!("{}", q_datetime_inf), String::from("0Wz"));
    /// }
    /// ```
    /// # Note
    /// The range of datetime in Rust is narrower than in q.
    pub const DATETIME: Lazy<DateTime<Utc>> =
        Lazy::new(|| DateTime::<Utc>::MAX_UTC - Duration::nanoseconds(999999));

    /// Infinity value of timespan (`0Wn`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timespan_inf = K::new_timespan(*qinf::TIMESPAN);
    ///     assert_eq!(format!("{}", q_timespan_inf), String::from("0Wn"));
    /// }
    /// ```
    pub const TIMESPAN: Lazy<Duration> = Lazy::new(|| Duration::nanoseconds(qinf_base::J));

    /// Infinity value of minute (`0Wu`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_minute_inf = K::new_minute(*qinf::MINUTE);
    ///     assert_eq!(format!("{}", q_minute_inf), String::from("0Wu"));
    /// }
    /// ```
    pub const MINUTE: Lazy<Duration> = Lazy::new(|| Duration::minutes(qinf_base::I as i64));

    /// Infinity value of second (`0Wv`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_second_inf = K::new_second(*qinf::SECOND);
    ///     assert_eq!(format!("{}", q_second_inf), String::from("0Wv"));
    /// }
    /// ```
    pub const SECOND: Lazy<Duration> = Lazy::new(|| Duration::seconds(qinf_base::I as i64));

    /// Infinity value of time (`0Wt`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_time_inf = K::new_time(*qinf::TIME);
    ///     assert_eq!(format!("{}", q_time_inf), String::from("0Wt"));
    /// }
    /// ```
    pub const TIME: Lazy<Duration> = Lazy::new(|| Duration::milliseconds(qinf_base::I as i64));
}

pub mod qninf {
    //! This module provides a list of q negative infinite values set on Rust process and used for IPC.
    //!  The motivation to contain them in a module is to tie them up as related items rather than
    //!  scattered values. Hence user should use these indicators with `qnull::` prefix, e.g., `qnull::FLOAT`.

    use super::qninf_base;
    use chrono::prelude::*;
    use chrono::Duration;
    use once_cell::sync::Lazy;

    /// Infinity value of short (`-0Wh`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_short_ninf = K::new_short(qninf::SHORT);
    ///     assert_eq!(format!("{}", q_short_ninf), String::from("-0Wh"));
    /// }
    /// ```
    pub const SHORT: i16 = qninf_base::H;

    /// Infinity value of int (`-0Wi`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_int_ninf = K::new_int(qninf::INT);
    ///     assert_eq!(format!("{}", q_int_ninf), String::from("-0Wi"));
    /// }
    /// ```
    pub const INT: i32 = qninf_base::I;

    /// Infinity value of long (-`0W`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_long_ninf = K::new_long(qninf::LONG);
    ///     assert_eq!(format!("{}", q_long_ninf), String::from("-0W"));
    /// }
    /// ```
    pub const LONG: i64 = qninf_base::J;

    /// Infinity value of real (`-0We`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_real_ninf: K = K::new_real(qninf::REAL);
    ///     assert_eq!(format!("{}", q_real_ninf), String::from("-0We"));
    /// }
    /// ```
    pub const REAL: f32 = qninf_base::E;

    /// Infinity value of float (`-0w`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_float_ninf = K::new_float(qninf::FLOAT);
    ///     assert_eq!(format!("{}", q_float_ninf), String::from("-0w"));
    /// }
    /// ```
    pub const FLOAT: f64 = qninf_base::F;

    /// Infinity value of timestamp (`-0Wp`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timestamp_ninf = K::new_timestamp(*qninf::TIMESTAMP);
    ///     assert_eq!(format!("{}", q_timestamp_ninf), String::from("-0Wp"));
    /// }
    /// ```
    /// # Note
    /// The range of timestamp in Rust is wider than in q.
    pub const TIMESTAMP: Lazy<DateTime<Utc>> = Lazy::new(|| {
        NaiveDate::from_ymd_opt(1707, 9, 22)
            .unwrap()
            .and_hms_nano_opt(0, 12, 43, 145224193)
            .unwrap()
            .and_local_timezone(Utc)
            .unwrap()
    });

    /// Infinity value of month (`-0Wm`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_month_ninf = K::new_month(*qninf::MONTH);
    ///     assert_eq!(format!("{}", q_month_ninf), String::from("-0Wm"));
    /// }
    /// ```
    /// # Note
    /// The range of month in Rust is narrower than in q.
    pub const MONTH: Lazy<NaiveDate> = Lazy::new(|| NaiveDate::MIN + Duration::days(31));

    /// Infinity valueo of date (`-0Wd`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_date_ninf = K::new_date(*qninf::DATE);
    ///     assert_eq!(format!("{}", q_date_ninf), String::from("-0Wd"));
    /// }
    /// ```
    /// # Note
    /// The range of date in Rust is narrower than in q.
    pub const DATE: Lazy<NaiveDate> = Lazy::new(|| NaiveDate::MIN + Duration::days(1));

    /// Infinity value of datetime (`-0Wz`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_datetime_ninf = K::new_datetime(*qninf::DATETIME);
    ///     assert_eq!(format!("{}", q_datetime_ninf), String::from("-0Wz"));
    /// }
    /// ```
    /// # Note
    /// The range of datetime in Rust is narrower than in q.
    pub const DATETIME: Lazy<DateTime<Utc>> =
        Lazy::new(|| DateTime::<Utc>::MIN_UTC + Duration::nanoseconds(1000000));

    /// Infinity value of timespan (`-0Wn`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_timespan_ninf = K::new_timespan(*qninf::TIMESPAN);
    ///     assert_eq!(format!("{}", q_timespan_ninf), String::from("-0Wn"));
    /// }
    /// ```
    pub const TIMESPAN: Lazy<Duration> = Lazy::new(|| Duration::nanoseconds(qninf_base::J));

    /// Infinity value of minute (`-0Wu`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_minute_ninf = K::new_minute(*qninf::MINUTE);
    ///     assert_eq!(format!("{}", q_minute_ninf), String::from("-0Wu"));
    /// }
    /// ```
    pub const MINUTE: Lazy<Duration> = Lazy::new(|| Duration::minutes(qninf_base::I as i64));

    /// Infinity value of second (`-0Wv`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_second_ninf = K::new_second(*qninf::SECOND);
    ///     assert_eq!(format!("{}", q_second_ninf), String::from("-0Wv"));
    /// }
    /// ```
    pub const SECOND: Lazy<Duration> = Lazy::new(|| Duration::seconds(qninf_base::I as i64));

    /// Infinity value of time (`-0Wt`).
    /// # Example
    /// ```
    /// use kdb_codec::*;
    ///
    /// fn main() {
    ///     let q_time_ninf = K::new_time(*qninf::TIME);
    ///     assert_eq!(format!("{}", q_time_ninf), String::from("-0Wt"));
    /// }
    /// ```
    pub const TIME: Lazy<Duration> = Lazy::new(|| Duration::milliseconds(qninf_base::I as i64));
}