Skip to main content

mssql_types/
encode.rs

1//! TDS binary encoding for SQL values.
2//!
3//! This module provides encoding of Rust values into TDS wire format
4//! for transmission to SQL Server.
5
6// Allow expect() for chrono date construction with known-valid constant dates
7#![allow(clippy::expect_used)]
8
9use bytes::{BufMut, BytesMut};
10
11use crate::error::TypeError;
12use crate::value::SqlValue;
13
14/// Trait for encoding values to TDS binary format.
15pub trait TdsEncode {
16    /// Encode this value into the buffer in TDS format.
17    fn encode(&self, buf: &mut BytesMut) -> Result<(), TypeError>;
18
19    /// Get the TDS type ID for this value.
20    fn type_id(&self) -> u8;
21}
22
23impl TdsEncode for SqlValue {
24    fn encode(&self, buf: &mut BytesMut) -> Result<(), TypeError> {
25        match self {
26            SqlValue::Null => {
27                // NULL is represented by length indicator in most contexts
28                // For INTNTYPE, length 0 means NULL
29                Ok(())
30            }
31            SqlValue::Bool(v) => {
32                buf.put_u8(if *v { 1 } else { 0 });
33                Ok(())
34            }
35            SqlValue::TinyInt(v) => {
36                buf.put_u8(*v);
37                Ok(())
38            }
39            SqlValue::SmallInt(v) => {
40                buf.put_i16_le(*v);
41                Ok(())
42            }
43            SqlValue::Int(v) => {
44                buf.put_i32_le(*v);
45                Ok(())
46            }
47            SqlValue::BigInt(v) => {
48                buf.put_i64_le(*v);
49                Ok(())
50            }
51            SqlValue::Float(v) => {
52                buf.put_f32_le(*v);
53                Ok(())
54            }
55            SqlValue::Double(v) => {
56                buf.put_f64_le(*v);
57                Ok(())
58            }
59            SqlValue::String(s) => {
60                // Encode as UTF-16LE for NVARCHAR
61                encode_utf16_string(s, buf);
62                Ok(())
63            }
64            SqlValue::Binary(b) => {
65                // Length-prefixed binary data
66                if b.len() > u16::MAX as usize {
67                    return Err(TypeError::BufferTooSmall {
68                        needed: b.len(),
69                        available: u16::MAX as usize,
70                    });
71                }
72                buf.put_u16_le(b.len() as u16);
73                buf.put_slice(b);
74                Ok(())
75            }
76            #[cfg(feature = "decimal")]
77            SqlValue::Decimal(d) => {
78                encode_decimal(*d, buf);
79                Ok(())
80            }
81            #[cfg(feature = "decimal")]
82            SqlValue::Money(d) => encode_money(*d, buf),
83            #[cfg(feature = "decimal")]
84            SqlValue::SmallMoney(d) => encode_smallmoney(*d, buf),
85            #[cfg(feature = "uuid")]
86            SqlValue::Uuid(u) => {
87                encode_uuid(*u, buf);
88                Ok(())
89            }
90            #[cfg(feature = "chrono")]
91            SqlValue::Date(d) => encode_date(*d, buf),
92            #[cfg(feature = "chrono")]
93            SqlValue::Time(t) => {
94                encode_time(*t, buf);
95                Ok(())
96            }
97            #[cfg(feature = "chrono")]
98            SqlValue::DateTime(dt) => encode_datetime2(*dt, buf),
99            #[cfg(feature = "chrono")]
100            SqlValue::SmallDateTime(dt) => encode_smalldatetime(*dt, buf),
101            #[cfg(feature = "chrono")]
102            SqlValue::DateTimeOffset(dto) => encode_datetimeoffset(*dto, buf),
103            #[cfg(feature = "json")]
104            SqlValue::Json(j) => {
105                // JSON is sent as NVARCHAR string
106                let s = j.to_string();
107                encode_utf16_string(&s, buf);
108                Ok(())
109            }
110            SqlValue::Xml(x) => {
111                // XML is sent as UTF-16LE string
112                encode_utf16_string(x, buf);
113                Ok(())
114            }
115            SqlValue::Tvp(_) => {
116                // TVP encoding is handled at the RPC parameter level, not here.
117                // This method is for encoding the value data portion; TVPs have
118                // their own complex encoding structure that includes metadata.
119                // See tds-protocol crate for full TVP encoding.
120                Err(TypeError::UnsupportedConversion {
121                    from: "TvpData".to_string(),
122                    to: "raw bytes (use RPC parameter encoding)",
123                })
124            }
125        }
126    }
127
128    fn type_id(&self) -> u8 {
129        match self {
130            SqlValue::Null => 0x1F,        // NULLTYPE
131            SqlValue::Bool(_) => 0x32,     // BITTYPE
132            SqlValue::TinyInt(_) => 0x30,  // INT1TYPE
133            SqlValue::SmallInt(_) => 0x34, // INT2TYPE
134            SqlValue::Int(_) => 0x38,      // INT4TYPE
135            SqlValue::BigInt(_) => 0x7F,   // INT8TYPE
136            SqlValue::Float(_) => 0x3B,    // FLT4TYPE
137            SqlValue::Double(_) => 0x3E,   // FLT8TYPE
138            SqlValue::String(_) => 0xE7,   // NVARCHARTYPE
139            SqlValue::Binary(_) => 0xA5,   // BIGVARBINTYPE
140            #[cfg(feature = "decimal")]
141            SqlValue::Decimal(_) => 0x6C, // DECIMALTYPE
142            #[cfg(feature = "decimal")]
143            SqlValue::Money(_) => 0x6E, // MONEYNTYPE (8-byte payload)
144            #[cfg(feature = "decimal")]
145            SqlValue::SmallMoney(_) => 0x6E, // MONEYNTYPE (4-byte payload)
146            #[cfg(feature = "uuid")]
147            SqlValue::Uuid(_) => 0x24, // GUIDTYPE
148            #[cfg(feature = "chrono")]
149            SqlValue::Date(_) => 0x28, // DATETYPE
150            #[cfg(feature = "chrono")]
151            SqlValue::Time(_) => 0x29, // TIMETYPE
152            #[cfg(feature = "chrono")]
153            SqlValue::DateTime(_) => 0x2A, // DATETIME2TYPE
154            #[cfg(feature = "chrono")]
155            SqlValue::SmallDateTime(_) => 0x6F, // DATETIMENTYPE (4-byte payload)
156            #[cfg(feature = "chrono")]
157            SqlValue::DateTimeOffset(_) => 0x2B, // DATETIMEOFFSETTYPE
158            #[cfg(feature = "json")]
159            SqlValue::Json(_) => 0xE7, // NVARCHARTYPE (JSON as string)
160            SqlValue::Xml(_) => 0xF1,      // XMLTYPE
161            SqlValue::Tvp(_) => 0xF3,      // TVPTYPE
162        }
163    }
164}
165
166/// Encode a string as UTF-16LE with length prefix.
167pub fn encode_utf16_string(s: &str, buf: &mut BytesMut) {
168    let utf16: Vec<u16> = s.encode_utf16().collect();
169    let byte_len = utf16.len() * 2;
170
171    // Write byte length (not char length)
172    buf.put_u16_le(byte_len as u16);
173
174    // Write UTF-16LE bytes
175    for code_unit in utf16 {
176        buf.put_u16_le(code_unit);
177    }
178}
179
180/// Encode a string as UTF-16LE without length prefix (for fixed-length fields).
181pub fn encode_utf16_string_no_len(s: &str, buf: &mut BytesMut) {
182    for code_unit in s.encode_utf16() {
183        buf.put_u16_le(code_unit);
184    }
185}
186
187/// Encode a UUID in SQL Server's mixed-endian format.
188///
189/// SQL Server stores UUIDs in a unique byte order:
190/// - First 4 bytes: little-endian
191/// - Next 2 bytes: little-endian
192/// - Next 2 bytes: little-endian
193/// - Last 8 bytes: big-endian (as-is)
194#[cfg(feature = "uuid")]
195pub fn encode_uuid(uuid: uuid::Uuid, buf: &mut BytesMut) {
196    let bytes = uuid.as_bytes();
197
198    // First group (4 bytes) - reverse for little-endian
199    buf.put_u8(bytes[3]);
200    buf.put_u8(bytes[2]);
201    buf.put_u8(bytes[1]);
202    buf.put_u8(bytes[0]);
203
204    // Second group (2 bytes) - reverse for little-endian
205    buf.put_u8(bytes[5]);
206    buf.put_u8(bytes[4]);
207
208    // Third group (2 bytes) - reverse for little-endian
209    buf.put_u8(bytes[7]);
210    buf.put_u8(bytes[6]);
211
212    // Last 8 bytes - big-endian (keep as-is)
213    buf.put_slice(&bytes[8..16]);
214}
215
216/// Encode a decimal value.
217///
218/// TDS DECIMAL format:
219/// - 1 byte: sign (0 = negative, 1 = positive)
220/// - Remaining bytes: absolute value in little-endian
221#[cfg(feature = "decimal")]
222pub fn encode_decimal(decimal: rust_decimal::Decimal, buf: &mut BytesMut) {
223    let sign = if decimal.is_sign_negative() { 0u8 } else { 1u8 };
224    buf.put_u8(sign);
225
226    // Get the mantissa and encode as 128-bit integer
227    let mantissa = decimal.mantissa().unsigned_abs();
228    buf.put_u128_le(mantissa);
229}
230
231/// Rescale a decimal to MONEY's 4-decimal fixed-point representation.
232///
233/// Returns the signed 128-bit integer representing the value multiplied by
234/// 10_000. Excess precision past 4 decimal places is truncated toward zero.
235#[cfg(feature = "decimal")]
236fn decimal_to_money_cents(value: rust_decimal::Decimal) -> Result<i128, TypeError> {
237    let mantissa: i128 = value.mantissa();
238    let scale: u32 = value.scale();
239    if scale <= 4 {
240        let factor = 10_i128.pow(4 - scale);
241        mantissa.checked_mul(factor).ok_or(TypeError::OutOfRange {
242            target_type: "MONEY",
243        })
244    } else {
245        let factor = 10_i128.pow(scale - 4);
246        Ok(mantissa / factor)
247    }
248}
249
250/// Convert a decimal to the scaled i64 used on the MONEY wire.
251///
252/// This is the shared pre-encoding step for both RPC parameter encoding and
253/// TVP column encoding — each path knows how to frame the payload, but they
254/// agree on how to derive the scaled integer from the decimal.
255#[cfg(feature = "decimal")]
256pub fn decimal_to_money_cents_i64(value: rust_decimal::Decimal) -> Result<i64, TypeError> {
257    let cents_i128 = decimal_to_money_cents(value)?;
258    i64::try_from(cents_i128).map_err(|_| TypeError::OutOfRange {
259        target_type: "MONEY",
260    })
261}
262
263/// Convert a decimal to the scaled i32 used on the SMALLMONEY wire.
264#[cfg(feature = "decimal")]
265pub fn decimal_to_smallmoney_cents_i32(value: rust_decimal::Decimal) -> Result<i32, TypeError> {
266    let cents_i128 = decimal_to_money_cents(value)?;
267    i32::try_from(cents_i128).map_err(|_| TypeError::OutOfRange {
268        target_type: "SMALLMONEY",
269    })
270}
271
272/// Encode a decimal as MONEY (8 bytes): the signed 64-bit scaled integer is
273/// written as the high 32 bits LE followed by the low 32 bits LE, per
274/// MS-TDS §2.2.5.5.1.2.
275#[cfg(feature = "decimal")]
276pub fn encode_money(value: rust_decimal::Decimal, buf: &mut BytesMut) -> Result<(), TypeError> {
277    let cents = decimal_to_money_cents_i64(value)?;
278    let high = (cents >> 32) as i32;
279    let low = (cents & 0xFFFF_FFFF) as u32;
280    buf.put_i32_le(high);
281    buf.put_u32_le(low);
282    Ok(())
283}
284
285/// Encode a decimal as SMALLMONEY (4 bytes): the signed 32-bit scaled integer
286/// is written little-endian.
287#[cfg(feature = "decimal")]
288pub fn encode_smallmoney(
289    value: rust_decimal::Decimal,
290    buf: &mut BytesMut,
291) -> Result<(), TypeError> {
292    let cents = decimal_to_smallmoney_cents_i32(value)?;
293    buf.put_i32_le(cents);
294    Ok(())
295}
296
297/// Convert a NaiveDateTime to the DATETIME wire representation.
298///
299/// Returns `(days_since_1900_i32, ticks_u32)` where each tick is 1/300 second.
300/// This is the shared pre-encoding step for both RPC parameter encoding and
301/// TVP column encoding.
302#[cfg(feature = "chrono")]
303pub fn datetime_to_legacy_days_ticks(dt: chrono::NaiveDateTime) -> (i32, u32) {
304    use chrono::Timelike;
305    let epoch = chrono::NaiveDate::from_ymd_opt(1900, 1, 1).expect("epoch 1900-01-01 is valid");
306    let days = (dt.date() - epoch).num_days() as i32;
307
308    let since_midnight = dt.time().num_seconds_from_midnight() as u64 * 1000
309        + u64::from(dt.time().nanosecond()) / 1_000_000;
310    // Convert ms → 1/300s ticks: ticks = round(ms * 300 / 1000) = round(ms * 3 / 10)
311    let ticks = ((since_midnight * 3 + 5) / 10) as u32;
312    (days, ticks)
313}
314
315/// Encode a DATETIME value (8 bytes): days since 1900 (`i32` LE) + time units
316/// since midnight (`u32` LE) where each unit is 1/300 of a second.
317#[cfg(feature = "chrono")]
318pub fn encode_datetime_legacy(dt: chrono::NaiveDateTime, buf: &mut BytesMut) {
319    let (days, ticks) = datetime_to_legacy_days_ticks(dt);
320    buf.put_i32_le(days);
321    buf.put_u32_le(ticks);
322}
323
324/// Convert a NaiveDateTime to the SMALLDATETIME wire representation.
325///
326/// Returns `(days_since_1900_u16, minutes_since_midnight_u16)`. Seconds are
327/// rounded to the nearest minute (30s rounds up per SQL Server semantics); when
328/// that rounding lands on or past 24:00 the carry propagates into the next day
329/// — e.g. 23:59:45 → next day 00:00 — so the result stays within SQL Server's
330/// valid minute range of 0..1439. Returns `Err` if the resulting date is
331/// outside the SMALLDATETIME range (1900-01-01 through 2079-06-06).
332#[cfg(feature = "chrono")]
333pub fn datetime_to_smalldatetime_days_minutes(
334    dt: chrono::NaiveDateTime,
335) -> Result<(u16, u16), TypeError> {
336    use chrono::Timelike;
337    let epoch = chrono::NaiveDate::from_ymd_opt(1900, 1, 1).expect("epoch 1900-01-01 is valid");
338
339    let total_seconds = dt.time().hour() * 3600 + dt.time().minute() * 60 + dt.time().second();
340    let minutes_raw = (total_seconds + 30) / 60;
341    // Carry over into the next day when seconds round up past 24:00 so that
342    // the returned minute count stays within SQL Server's valid 0..1439 range.
343    // SQL Server itself does the same thing when casting 23:59:45 to
344    // SMALLDATETIME — sending minutes=1440 directly on the wire is rejected
345    // as "invalid instance of data type smalldatetime".
346    let (day_carry, minutes) = if minutes_raw >= 1440 {
347        (1i64, 0u16)
348    } else {
349        (0i64, minutes_raw as u16)
350    };
351
352    let days_i64 = (dt.date() - epoch).num_days() + day_carry;
353    let days: u16 = u16::try_from(days_i64).map_err(|_| {
354        TypeError::InvalidDateTime(format!(
355            "SMALLDATETIME year must be 1900-2079, got date with {days_i64} days since 1900-01-01"
356        ))
357    })?;
358
359    Ok((days, minutes))
360}
361
362/// Encode a SMALLDATETIME value (4 bytes): days since 1900 (`u16` LE) +
363/// minutes since midnight (`u16` LE). Seconds are rounded to the nearest
364/// minute (30s rounds up per SQL Server semantics).
365///
366/// # Errors
367///
368/// Returns an error if the date is outside the SMALLDATETIME range
369/// (1900-01-01 through 2079-06-06).
370#[cfg(feature = "chrono")]
371pub fn encode_smalldatetime(
372    dt: chrono::NaiveDateTime,
373    buf: &mut BytesMut,
374) -> Result<(), TypeError> {
375    let (days, minutes) = datetime_to_smalldatetime_days_minutes(dt)?;
376    buf.put_u16_le(days);
377    buf.put_u16_le(minutes);
378    Ok(())
379}
380
381/// Encode a DATE value.
382///
383/// TDS DATE is the number of days since 0001-01-01.
384///
385/// # Errors
386///
387/// Returns an error if the date is outside SQL Server's DATE range
388/// (0001-01-01 through 9999-12-31). chrono permits dates beyond both ends,
389/// which previously wrapped silently into garbage wire values.
390#[cfg(feature = "chrono")]
391pub fn encode_date(date: chrono::NaiveDate, buf: &mut BytesMut) -> Result<(), TypeError> {
392    /// Days from 0001-01-01 to 9999-12-31, the last representable DATE.
393    const MAX_DAYS: i64 = 3_652_058;
394
395    let base = chrono::NaiveDate::from_ymd_opt(1, 1, 1).expect("valid date");
396    let days = date.signed_duration_since(base).num_days();
397    if !(0..=MAX_DAYS).contains(&days) {
398        return Err(TypeError::InvalidDateTime(format!(
399            "DATE must be between 0001-01-01 and 9999-12-31, got {date}"
400        )));
401    }
402    let days = days as u32;
403
404    // DATE is encoded as 3 bytes (little-endian)
405    buf.put_u8((days & 0xFF) as u8);
406    buf.put_u8(((days >> 8) & 0xFF) as u8);
407    buf.put_u8(((days >> 16) & 0xFF) as u8);
408    Ok(())
409}
410
411/// Encode a TIME value.
412///
413/// TDS TIME is encoded as 100-nanosecond intervals since midnight.
414#[cfg(feature = "chrono")]
415pub fn encode_time(time: chrono::NaiveTime, buf: &mut BytesMut) {
416    use chrono::Timelike;
417
418    // Calculate 100-ns intervals since midnight
419    // Scale = 7 (100-nanosecond precision)
420    let nanos = time.num_seconds_from_midnight() as u64 * 1_000_000_000 + time.nanosecond() as u64;
421    let intervals = nanos / 100;
422
423    // TIME with scale 7 uses 5 bytes
424    buf.put_u8((intervals & 0xFF) as u8);
425    buf.put_u8(((intervals >> 8) & 0xFF) as u8);
426    buf.put_u8(((intervals >> 16) & 0xFF) as u8);
427    buf.put_u8(((intervals >> 24) & 0xFF) as u8);
428    buf.put_u8(((intervals >> 32) & 0xFF) as u8);
429}
430
431/// Encode a DATETIME2 value.
432///
433/// DATETIME2 is encoded as TIME followed by DATE.
434///
435/// # Errors
436///
437/// Returns an error if the date portion is outside the DATE range; see
438/// [`encode_date`].
439#[cfg(feature = "chrono")]
440pub fn encode_datetime2(
441    datetime: chrono::NaiveDateTime,
442    buf: &mut BytesMut,
443) -> Result<(), TypeError> {
444    encode_time(datetime.time(), buf);
445    encode_date(datetime.date(), buf)
446}
447
448/// Encode a DATETIMEOFFSET value.
449///
450/// DATETIMEOFFSET is encoded as TIME + DATE + offset (in minutes). Per
451/// MS-TDS §2.2.5.5.1.9 the date/time portion is the **UTC** instant, not the
452/// local wall-clock; the offset is carried separately.
453#[cfg(feature = "chrono")]
454pub fn encode_datetimeoffset(
455    datetime: chrono::DateTime<chrono::FixedOffset>,
456    buf: &mut BytesMut,
457) -> Result<(), TypeError> {
458    use chrono::Offset;
459
460    // Encode the UTC date/time components
461    let utc = datetime.naive_utc();
462    encode_time(utc.time(), buf);
463    encode_date(utc.date(), buf)?;
464
465    // Encode timezone offset in minutes (signed 16-bit)
466    let offset_seconds = datetime.offset().fix().local_minus_utc();
467    let offset_minutes = (offset_seconds / 60) as i16;
468    buf.put_i16_le(offset_minutes);
469    Ok(())
470}
471
472#[cfg(test)]
473#[allow(clippy::unwrap_used)]
474mod tests {
475    use super::*;
476
477    /// JSON values are sent on the wire as NVARCHAR — the serialized JSON
478    /// string encoded as UTF-16LE. This encode path had no asserting test.
479    #[cfg(feature = "json")]
480    #[test]
481    fn test_json_encodes_as_nvarchar() {
482        let value = serde_json::json!({"name": "Ada", "id": 42});
483
484        let mut got = BytesMut::new();
485        SqlValue::Json(value.clone()).encode(&mut got).unwrap();
486
487        let mut want = BytesMut::new();
488        encode_utf16_string(&value.to_string(), &mut want);
489        assert_eq!(got, want);
490    }
491
492    /// Issue #152 regression: the DATETIMEOFFSET wire date/time portion is
493    /// the UTC instant per MS-TDS §2.2.5.5.1.9. 12:00 at +02:00 must encode
494    /// a 10:00 time portion. The previous encoder wrote the local wall-clock,
495    /// shifting every non-zero-offset value when read by other drivers or
496    /// compared server-side.
497    #[cfg(feature = "chrono")]
498    #[test]
499    fn test_datetimeoffset_encodes_utc_instant() {
500        use chrono::TimeZone;
501
502        let offset = chrono::FixedOffset::east_opt(2 * 3600).unwrap();
503        let dto = offset.with_ymd_and_hms(2024, 3, 15, 12, 0, 0).unwrap();
504
505        let mut buf = BytesMut::new();
506        encode_datetimeoffset(dto, &mut buf).unwrap();
507        assert_eq!(buf.len(), 10); // 5 time + 3 date + 2 offset
508
509        // Time portion: 100ns intervals since midnight of the UTC instant.
510        let mut intervals: u64 = 0;
511        for i in 0..5 {
512            intervals |= u64::from(buf[i]) << (8 * i);
513        }
514        assert_eq!(intervals, 10 * 3600 * 10_000_000, "time must be 10:00 UTC");
515
516        // Date portion: days since 0001-01-01 of the UTC date.
517        let days = u32::from(buf[5]) | (u32::from(buf[6]) << 8) | (u32::from(buf[7]) << 16);
518        let base = chrono::NaiveDate::from_ymd_opt(1, 1, 1).unwrap();
519        let expected_days =
520            (chrono::NaiveDate::from_ymd_opt(2024, 3, 15).unwrap() - base).num_days() as u32;
521        assert_eq!(days, expected_days);
522
523        // Offset: +120 minutes, unchanged.
524        assert_eq!(i16::from_le_bytes([buf[8], buf[9]]), 120);
525    }
526
527    #[test]
528    fn test_encode_int() {
529        let mut buf = BytesMut::new();
530        SqlValue::Int(42).encode(&mut buf).unwrap();
531        assert_eq!(&buf[..], &[42, 0, 0, 0]);
532    }
533
534    #[test]
535    fn test_encode_bigint() {
536        let mut buf = BytesMut::new();
537        SqlValue::BigInt(0x0102030405060708)
538            .encode(&mut buf)
539            .unwrap();
540        assert_eq!(&buf[..], &[0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01]);
541    }
542
543    #[test]
544    fn test_encode_utf16_string() {
545        let mut buf = BytesMut::new();
546        encode_utf16_string("AB", &mut buf);
547        // Length (4 bytes for 2 UTF-16 code units) + "AB" in UTF-16LE
548        assert_eq!(&buf[..], &[4, 0, 0x41, 0, 0x42, 0]);
549    }
550
551    #[cfg(feature = "uuid")]
552    #[test]
553    fn test_encode_uuid() {
554        let mut buf = BytesMut::new();
555        let uuid = uuid::Uuid::parse_str("12345678-1234-5678-1234-567812345678").unwrap();
556        encode_uuid(uuid, &mut buf);
557        // SQL Server mixed-endian format
558        assert_eq!(
559            &buf[..],
560            &[
561                0x78, 0x56, 0x34, 0x12, // First group reversed
562                0x34, 0x12, // Second group reversed
563                0x78, 0x56, // Third group reversed
564                0x12, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78 // Last 8 bytes as-is
565            ]
566        );
567    }
568
569    #[cfg(feature = "chrono")]
570    /// Issue #167 regression: chrono dates outside SQL Server's DATE range
571    /// (0001-01-01..9999-12-31) silently wrapped `num_days() as u32` into
572    /// garbage wire values. They must error; the boundaries must encode.
573    #[test]
574    fn test_encode_date_range_enforced() {
575        let mut buf = BytesMut::new();
576
577        // Both boundaries encode.
578        let min = chrono::NaiveDate::from_ymd_opt(1, 1, 1).unwrap();
579        encode_date(min, &mut buf).unwrap();
580        assert_eq!(&buf[buf.len() - 3..], &[0, 0, 0]);
581        let max = chrono::NaiveDate::from_ymd_opt(9999, 12, 31).unwrap();
582        encode_date(max, &mut buf).unwrap();
583        // 3_652_058 = 0x37B9DA little-endian
584        assert_eq!(&buf[buf.len() - 3..], &[0xDA, 0xB9, 0x37]);
585
586        // One day past either boundary errors instead of wrapping.
587        let before = chrono::NaiveDate::from_ymd_opt(0, 12, 31).unwrap();
588        assert!(matches!(
589            encode_date(before, &mut buf),
590            Err(TypeError::InvalidDateTime(_))
591        ));
592        let after = chrono::NaiveDate::from_ymd_opt(10000, 1, 1).unwrap();
593        assert!(matches!(
594            encode_date(after, &mut buf),
595            Err(TypeError::InvalidDateTime(_))
596        ));
597
598        // The composite encoders propagate the range error.
599        let dt = before.and_hms_opt(12, 0, 0).unwrap();
600        assert!(encode_datetime2(dt, &mut buf).is_err());
601    }
602
603    #[test]
604    fn test_encode_date() {
605        let mut buf = BytesMut::new();
606        let date = chrono::NaiveDate::from_ymd_opt(2024, 1, 15).unwrap();
607        encode_date(date, &mut buf).unwrap();
608        // Should be 3 bytes representing days since 0001-01-01
609        assert_eq!(buf.len(), 3);
610    }
611}