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

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

use crate::datatypes::column_values::ColumnValues;
use crate::query::metadata::ColumnMetadata;
use crate::token::tokenitems::ReturnValueStatus;
use crate::token::tokens::ReturnValueToken;

/// A value returned from a stored procedure or prepared statement — either an
/// `OUTPUT` parameter or a UDF return value.
///
/// Collected automatically as the TDS token stream is read. Use
/// [`TdsClient::get_return_values()`](crate::TdsClient::get_return_values) or
/// [`TdsClient::retrieve_output_params()`](crate::TdsClient::retrieve_output_params)
/// to access them after the result set is consumed.
#[derive(Debug, Clone)]
pub struct ReturnValue {
    /// Zero-based ordinal position of the parameter in the RPC call.
    pub param_ordinal: u16,
    /// Parameter name as declared in the stored procedure (may be empty for
    /// positional parameters).
    pub param_name: String,
    /// The returned value, decoded into the appropriate [`ColumnValues`]
    /// variant.
    pub value: ColumnValues,
    /// Type metadata (data type, precision, scale, collation, etc.).
    pub column_metadata: Box<ColumnMetadata>,
    /// Whether this is an `OUTPUT` parameter or a UDF return value.
    pub status: ReturnValueStatus,
}

impl From<ReturnValueToken> for ReturnValue {
    fn from(token: ReturnValueToken) -> Self {
        ReturnValue {
            param_ordinal: token.param_ordinal,
            param_name: token.param_name,
            value: token.value,
            column_metadata: token.column_metadata,
            status: token.status,
        }
    }
}