mssql-tds 0.1.0

Rust implementation of the TDS (Tabular Data Stream) protocol for SQL Server
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

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

/// Status of a TDS `RETURNVALUE` token, indicating whether the value
/// is an output parameter or a user-defined function return.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ReturnValueStatus {
    /// Output parameter.
    OutputParam,
    /// User-defined function return.
    Udf,
    /// Unrecognized status byte.
    Unknown(u8),
}

impl From<u8> for ReturnValueStatus {
    fn from(value: u8) -> Self {
        match value {
            0x01 => ReturnValueStatus::OutputParam,
            0x02 => ReturnValueStatus::Udf,
            _ => {
                tracing::warn!("Unknown ReturnValueStatus value: 0x{:02X}", value);
                ReturnValueStatus::Unknown(value)
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_return_value_status_from_output_param() {
        assert_eq!(
            ReturnValueStatus::from(0x01),
            ReturnValueStatus::OutputParam
        );
    }

    #[test]
    fn test_return_value_status_from_udf() {
        assert_eq!(ReturnValueStatus::from(0x02), ReturnValueStatus::Udf);
    }

    #[test]
    fn test_return_value_status_from_unknown() {
        assert_eq!(
            ReturnValueStatus::from(0xFF),
            ReturnValueStatus::Unknown(0xFF)
        );
        assert_eq!(
            ReturnValueStatus::from(0x00),
            ReturnValueStatus::Unknown(0x00)
        );
        assert_eq!(
            ReturnValueStatus::from(0x03),
            ReturnValueStatus::Unknown(0x03)
        );
    }

    #[test]
    fn test_return_value_status_equality() {
        assert_eq!(
            ReturnValueStatus::OutputParam,
            ReturnValueStatus::OutputParam
        );
        assert_eq!(ReturnValueStatus::Udf, ReturnValueStatus::Udf);
        assert_ne!(ReturnValueStatus::OutputParam, ReturnValueStatus::Udf);
    }

    #[test]
    fn test_return_value_status_clone() {
        let status = ReturnValueStatus::OutputParam;
        let cloned = status;
        assert_eq!(status, cloned);
    }

    #[test]
    fn test_return_value_status_debug() {
        let status = ReturnValueStatus::OutputParam;
        let debug_str = format!("{status:?}");
        assert!(debug_str.contains("OutputParam"));
    }
}