Enum Value

pub enum Value<'a> {
    Int32(Option<i32>),
    Int64(Option<i64>),
    Float(Option<f32>),
    Double(Option<f64>),
    Text(Option<Cow<'a, str>>),
    Enum(Option<Cow<'a, str>>),
    Bytes(Option<Cow<'a, [u8]>>),
    Boolean(Option<bool>),
    Char(Option<char>),
    Array(Option<Vec<Value<'a>>>),
    Numeric(Option<BigDecimal>),
    Json(Option<Value>),
    Xml(Option<Cow<'a, str>>),
    Uuid(Option<Uuid>),
    DateTime(Option<DateTime<Utc>>),
    Date(Option<NaiveDate>),
    Time(Option<NaiveTime>),
}

A value we must parameterize for the prepared statement. Null values should be defined by their corresponding type variants with a None value for best compatibility.

Variants

Int32(Option<i32>)

32-bit signed integer.

Int64(Option<i64>)

64-bit signed integer.

Float(Option<f32>)

32-bit floating point.

Double(Option<f64>)

64-bit floating point.

Text(Option<Cow<'a, str>>)

String value.

Enum(Option<Cow<'a, str>>)

Database enum value.

Bytes(Option<Cow<'a, [u8]>>)

Bytes value.

Boolean(Option<bool>)

Boolean value.

Char(Option<char>)

A single character.

Array(Option<Vec<Value<'a>>>)

An array value (PostgreSQL).

Numeric(Option<BigDecimal>)

Available on crate feature bigdecimal only.

A numeric value.

Json(Option<Value>)

Available on crate feature json only.

A JSON value.

Xml(Option<Cow<'a, str>>)

A XML value.

Uuid(Option<Uuid>)

Available on crate feature uuid only.

An UUID value.

DateTime(Option<DateTime<Utc>>)

Available on crate feature chrono only.

A datetime value.

Date(Option<NaiveDate>)

Available on crate feature chrono only.

A date value.

Time(Option<NaiveTime>)

Available on crate feature chrono only.

A time value.

Implementations

impl<'a> Value<'a>

pub fn int32<I>(value: I) -> Self

where I: Into<i32>,

Creates a new 32-bit signed integer.

pub fn int64<I>(value: I) -> Self

where I: Into<i64>,

Creates a new 64-bit signed integer.

pub fn integer<I>(value: I) -> Self

where I: Into<i32>,

Creates a new 32-bit signed integer.

pub const fn numeric(value: BigDecimal) -> Self

Available on crate feature bigdecimal only.

Creates a new decimal value.

pub const fn float(value: f32) -> Self

Creates a new float value.

pub const fn double(value: f64) -> Self

Creates a new double value.

pub fn text<T>(value: T) -> Self

where T: Into<Cow<'a, str>>,

Creates a new string value.

pub fn enum_variant<T>(value: T) -> Self

where T: Into<Cow<'a, str>>,

Creates a new enum value.

pub fn bytes<B>(value: B) -> Self

where B: Into<Cow<'a, [u8]>>,

Creates a new bytes value.

pub fn boolean<B>(value: B) -> Self

where B: Into<bool>,

Creates a new boolean value.

pub fn character<C>(value: C) -> Self

where C: Into<char>,

Creates a new character value.

pub fn array<I, V>(value: I) -> Self

where I: IntoIterator<Item = V>, V: Into<Value<'a>>,

Creates a new array value.

pub const fn uuid(value: Uuid) -> Self

Available on crate feature uuid only.

Creates a new uuid value.

pub const fn datetime(value: DateTime<Utc>) -> Self

Available on crate feature chrono only.

Creates a new datetime value.

pub const fn date(value: NaiveDate) -> Self

Available on crate feature chrono only.

Creates a new date value.

pub const fn time(value: NaiveTime) -> Self

Available on crate feature chrono only.

Creates a new time value.

pub const fn json(value: Value) -> Self

Available on crate feature json only.

Creates a new JSON value.

pub fn xml<T>(value: T) -> Self

where T: Into<Cow<'a, str>>,

Creates a new XML value.

pub const fn is_null(&self) -> bool

true if the Value is null.

pub const fn is_text(&self) -> bool

true if the Value is text.

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

Returns a &str if the value is text, otherwise None.

pub const fn as_char(&self) -> Option<char>

Returns a char if the value is a char, otherwise None.

pub fn to_string(&self) -> Option<String>

Returns a cloned String if the value is text, otherwise None.

pub fn into_string(self) -> Option<String>

Transforms the Value to a String if it’s text, otherwise None.

pub const fn is_bytes(&self) -> bool

Returns whether this value is the Bytes variant.

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

Returns a bytes slice if the value is text or a byte slice, otherwise None.

pub fn to_bytes(&self) -> Option<Vec<u8>>

Returns a cloned Vec<u8> if the value is text or a byte slice, otherwise None.

pub const fn is_i32(&self) -> bool

true if the Value is a 32-bit signed integer.

pub const fn is_i64(&self) -> bool

true if the Value is a 64-bit signed integer.

pub const fn is_integer(&self) -> bool

true if the Value is a signed integer.

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

Returns an i64 if the value is a 64-bit signed integer, otherwise None.

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

Returns an i32 if the value is a 32-bit signed integer, otherwise None.

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

Returns an i64 if the value is a signed integer, otherwise None.

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

Returns a f64 if the value is a double, otherwise None.

pub const fn as_f32(&self) -> Option<f32>

Returns a f32 if the value is a double, otherwise None.

pub const fn is_numeric(&self) -> bool

Available on crate feature bigdecimal only.

true if the Value is a numeric value or can be converted to one.

pub fn into_numeric(self) -> Option<BigDecimal>

Available on crate feature bigdecimal only.

Returns a bigdecimal, if the value is a numeric, float or double value, otherwise None.

pub const fn as_numeric(&self) -> Option<&BigDecimal>

Available on crate feature bigdecimal only.

Returns a reference to a bigdecimal, if the value is a numeric. Otherwise None.

pub const fn is_bool(&self) -> bool

true if the Value is a boolean value.

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

Returns a bool if the value is a boolean, otherwise None.

pub const fn is_array(&self) -> bool

true if the Value is an Array.

pub const fn is_uuid(&self) -> bool

Available on crate feature uuid only.

true if the Value is of UUID type.

pub const fn as_uuid(&self) -> Option<Uuid>

Available on crate feature uuid only.

Returns an UUID if the value is of UUID type, otherwise None.

pub const fn is_datetime(&self) -> bool

Available on crate feature chrono only.

true if the Value is a DateTime.

pub const fn as_datetime(&self) -> Option<DateTime<Utc>>

Available on crate feature chrono only.

Returns a DateTime if the value is a DateTime, otherwise None.

pub const fn is_date(&self) -> bool

Available on crate feature chrono only.

true if the Value is a Date.

pub const fn as_date(&self) -> Option<NaiveDate>

Available on crate feature chrono only.

Returns a NaiveDate if the value is a Date, otherwise None.

pub const fn is_time(&self) -> bool

Available on crate feature chrono only.

true if the Value is a Time.

pub const fn as_time(&self) -> Option<NaiveTime>

Available on crate feature chrono only.

Returns a NaiveTime if the value is a Time, otherwise None.

pub const fn is_json(&self) -> bool

Available on crate feature json only.

true if the Value is a JSON value.

pub const fn as_json(&self) -> Option<&Value>

Available on crate feature json only.

Returns a reference to a JSON Value if of Json type, otherwise None.

pub fn into_json(self) -> Option<Value>

Available on crate feature json only.

Transforms to a JSON Value if of Json type, otherwise None.

pub fn into_vec<T>(self) -> Option<Vec<T>>

where T: TryFrom<Value<'a>>,

Returns a Vec<T> if the value is an array of T, otherwise None.

pub fn to_vec<T>(&self) -> Option<Vec<T>>

where T: TryFrom<Value<'a>>,

Returns a cloned Vec if the value is an array of T, otherwise None.

Trait Implementations

impl<'a> Clone for Value<'a>

fn clone(&self) -> Value<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Value<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Value<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for Value<'a>

fn from(that: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Value<'a>

fn from(that: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<BigDecimal> for Value<'a>

fn from(that: BigDecimal) -> Self

Converts to this type from the input type.

impl<'a> From<DateTime<Utc>> for Value<'a>

fn from(that: DateTime<Utc>) -> Self

Converts to this type from the input type.

impl<'a> From<NaiveDate> for Value<'a>

fn from(that: NaiveDate) -> Self

Converts to this type from the input type.

impl<'a> From<NaiveTime> for Value<'a>

fn from(that: NaiveTime) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&'a [u8]>> for Value<'a>

fn from(that: Option<&'a [u8]>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<&'a str>> for Value<'a>

fn from(that: Option<&'a str>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<BigDecimal>> for Value<'a>

fn from(that: Option<BigDecimal>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<DateTime<Utc>>> for Value<'a>

fn from(that: Option<DateTime<Utc>>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<NaiveDate>> for Value<'a>

fn from(that: Option<NaiveDate>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<NaiveTime>> for Value<'a>

fn from(that: Option<NaiveTime>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<String>> for Value<'a>

fn from(that: Option<String>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<Uuid>> for Value<'a>

fn from(that: Option<Uuid>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<Value>> for Value<'a>

fn from(that: Option<JsonValue>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<bool>> for Value<'a>

fn from(that: Option<bool>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<f32>> for Value<'a>

fn from(that: Option<f32>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<f64>> for Value<'a>

fn from(that: Option<f64>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i32>> for Value<'a>

fn from(that: Option<i32>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<i64>> for Value<'a>

fn from(that: Option<i64>) -> Self

Converts to this type from the input type.

impl<'a> From<Option<usize>> for Value<'a>

fn from(that: Option<usize>) -> Self

Converts to this type from the input type.

impl<'a> From<String> for Value<'a>

fn from(that: String) -> Self

Converts to this type from the input type.

impl<'a> From<Uuid> for Value<'a>

fn from(that: Uuid) -> Self

Converts to this type from the input type.

impl<'a> From<Value<'a>> for Value

Available on crate feature json only.

fn from(pv: Value<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Value> for Value<'a>

fn from(that: JsonValue) -> Self

Converts to this type from the input type.

impl<'a> From<bool> for Value<'a>

fn from(that: bool) -> Self

Converts to this type from the input type.

impl<'a> From<f32> for Value<'a>

fn from(that: f32) -> Self

Converts to this type from the input type.

impl<'a> From<f64> for Value<'a>

fn from(that: f64) -> Self

Converts to this type from the input type.

impl<'a> From<i32> for Value<'a>

fn from(that: i32) -> Self

Converts to this type from the input type.

impl<'a> From<i64> for Value<'a>

fn from(that: i64) -> Self

Converts to this type from the input type.

impl<'a> From<usize> for Value<'a>

fn from(that: usize) -> Self

Converts to this type from the input type.

impl<'de> IntoDeserializer<'de> for Value<'de>

Available on crate feature serde-support only.

type Deserializer = ValueDeserializer<'de>

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<'a> IntoSql<'a> for &'a Value<'a>

fn into_sql(self) -> ColumnData<'a>

Convert to a value understood by the SQL Server. Conversion by-value.

impl<'a> PartialEq for Value<'a>

fn eq(&self, other: &Value<'a>) -> 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<'a> ToSql for Value<'a>

fn to_sql( &self, ty: &PostgresType, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn StdError + Send + Sync + 'static>>

Converts the value of self into the binary format of the specified Postgres Type, appending it to out.

fn accepts(_: &PostgresType) -> bool

Determines if a value of this type can be converted to the specified Postgres Type.

fn to_sql_checked( &self, ty: &Type, out: &mut BytesMut, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

An adaptor method used internally by Rust-Postgres.

fn encode_format(&self, _ty: &Type) -> Format

Specify the encode format

impl<'a> ToSql for Value<'a>

fn to_sql(&self) -> Result<ToSqlOutput<'_>, RusqlError>

Converts Rust value to SQLite value

impl<'a> TryFrom<&Value<'a>> for Option<BitVec>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value<'a>) -> Result<Option<BitVec>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&Value<'a>> for Option<IpAddr>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value<'a>) -> Result<Option<IpAddr>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&Value<'a>> for Option<Uuid>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value<'a>) -> Result<Option<Uuid>, Self::Error>

Performs the conversion.

impl TryFrom<ColumnData<'static>> for Value<'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cd: ColumnData<'static>) -> Result<Self>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for BigDecimal

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<BigDecimal, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for DateTime<Utc>

Available on crate feature chrono only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<DateTime<Utc>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for String

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<String, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for bool

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<bool, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for f64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<f64, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<i32, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<i64, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for Value<'a>

impl ValueIndex<ResultRow, Value<'static>> for &str

impl ValueIndex<ResultRow, Value<'static>> for usize

impl ValueIndex<ResultRowRef<'_>, Value<'static>> for &str

impl ValueIndex<ResultRowRef<'_>, Value<'static>> for usize