Enum SqlValue 

#[non_exhaustive]
pub enum SqlValue {
    Null,
    Bool(bool),
    TinyInt(u8),
    SmallInt(i16),
    Int(i32),
    BigInt(i64),
    Float(f32),
    Double(f64),
    String(String),
    Binary(Bytes),
    Decimal(Decimal),
    Uuid(Uuid),
    Date(NaiveDate),
    Time(NaiveTime),
    DateTime(NaiveDateTime),
    DateTimeOffset(DateTime<FixedOffset>),
    Xml(String),
    Tvp(Box<TvpData>),
}

A SQL value that can represent any SQL Server data type.

This enum provides a type-safe way to handle SQL values that may be of various types, including NULL.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

NULL value.

Bool(bool)

Boolean value (BIT).

TinyInt(u8)

8-bit unsigned integer (TINYINT).

SmallInt(i16)

16-bit signed integer (SMALLINT).

Int(i32)

32-bit signed integer (INT).

BigInt(i64)

64-bit signed integer (BIGINT).

Float(f32)

32-bit floating point (REAL).

Double(f64)

64-bit floating point (FLOAT).

String(String)

String value (CHAR, VARCHAR, NCHAR, NVARCHAR, TEXT, NTEXT).

Binary(Bytes)

Binary value (BINARY, VARBINARY, IMAGE).

Decimal(Decimal)

Decimal value (DECIMAL, NUMERIC, MONEY, SMALLMONEY).

Uuid(Uuid)

UUID value (UNIQUEIDENTIFIER).

Date(NaiveDate)

Date value (DATE).

Time(NaiveTime)

Time value (TIME).

DateTime(NaiveDateTime)

DateTime value (DATETIME, DATETIME2, SMALLDATETIME).

DateTimeOffset(DateTime<FixedOffset>)

DateTimeOffset value (DATETIMEOFFSET).

Xml(String)

XML value (XML type).

Tvp(Box<TvpData>)

Table-Valued Parameter (TVP).

TVPs allow passing collections of structured data to SQL Server stored procedures. Boxed due to large size.

Implementations

impl SqlValue

pub fn is_null(&self) -> bool

Check if the value is NULL.

pub fn as_bool(&self) -> Option<bool>

Get the value as a bool, if it is one.

pub fn as_i32(&self) -> Option<i32>

Get the value as an i32, if it is one.

pub fn as_i64(&self) -> Option<i64>

Get the value as an i64, if it is one.

pub fn as_f64(&self) -> Option<f64>

Get the value as an f64, if it is one.

pub fn as_str(&self) -> Option<&str>

Get the value as a string slice, if it is one.

pub fn as_bytes(&self) -> Option<&[u8]>

Get the value as bytes, if it is binary.

pub fn type_name(&self) -> &'static str

Get the type name as a string.

pub fn as_tvp(&self) -> Option<&TvpData>

Get the value as a TVP, if it is one.

Trait Implementations

impl Clone for SqlValue

fn clone(&self) -> SqlValue

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SqlValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SqlValue

fn default() -> Self

Returns the “default value” for a type.

impl From<&str> for SqlValue

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<Decimal> for SqlValue

Available on crate feature decimal only.

fn from(v: Decimal) -> Self

Converts to this type from the input type.

impl From<NaiveDate> for SqlValue

Available on crate feature chrono only.

fn from(v: NaiveDate) -> Self

Converts to this type from the input type.

impl From<NaiveDateTime> for SqlValue

Available on crate feature chrono only.

fn from(v: NaiveDateTime) -> Self

Converts to this type from the input type.

impl<T> From<Option<T>> for SqlValue

where T: Into<SqlValue>,

fn from(v: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for SqlValue

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<TvpData> for SqlValue

fn from(v: TvpData) -> Self

Converts to this type from the input type.

impl From<Uuid> for SqlValue

Available on crate feature uuid only.

fn from(v: Uuid) -> Self

Converts to this type from the input type.

impl From<bool> for SqlValue

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for SqlValue

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for SqlValue

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for SqlValue

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for SqlValue

fn from(v: i64) -> Self

Converts to this type from the input type.

impl PartialEq for SqlValue

fn eq(&self, other: &SqlValue) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TdsEncode for SqlValue

fn encode(&self, buf: &mut BytesMut) -> Result<(), TypeError>

Encode this value into the buffer in TDS format.

fn type_id(&self) -> u8

Get the TDS type ID for this value.

impl StructuralPartialEq for SqlValue