Struct oracle::SqlValue

pub struct SqlValue { /* fields omitted */ }

A type containing an Oracle value.

General users cannot use this directly. They access this via FromSql and ToSql.

When this is a column value in a select statement, the Oracle type is determined by the column type.

When this is a bind value in a SQL statement, the Oracle type is determined by ToSql.oratype which is internally called within Statement.bind, Statement.execute and Connection.execute.

Getter methods such as as_i64() do the followings:

1. Checks whether the conversion from the Oracle type to the target rust type is allowed. It returns Err(Error::InvalidTypeConversion(...)) when it isn't allowed.
2. Checks whether the Oracle value is null. It returns Err(Error::NullValue) when it is null. (is_null() is also available to check whether the value is null.)
3. Converts the Oracle value to the rust value. The data type is converted implicitly if required. For example string is converted to i64 by parse if as_i64() is called for VARCHAR2 columns. If the conversion fails, various errors are returned.

Setter methods such as set_i64() do the followings:

1. Checks whether the conversion from the rust type to the target Oracle type is allowed. It returns Err(Error::InvalidTypeConversion(...)) when it isn't allowed.
2. Converts the rust value to the Oracle value. The data type is converted implicitly if required. For example i64 is converted to string by to_string() if set_i64() is called for VARCHAR2 columns. If the conversion fails, various errors are returned. The value becomes not null.

The setter methods change the SQL value not null. You need to call set_null to make it null.

Methods

impl SqlValue

fn is_null(&self) -> Result<bool>

Returns Ok(true) when the SQL value is null. Ok(false) when it isn't null.

fn set_null(&mut self) -> Result<()>

Sets null to the SQL value.

fn oracle_type(&self) -> Result<&OracleType>

Gets the Oracle type of the SQL value.

fn as_i8(&self) -> Result<i8>

Gets the SQL value as i8. The Oracle type must be numeric or string (excluding LOB) types.

fn as_i16(&self) -> Result<i16>

Gets the SQL value as i16. The Oracle type must be numeric or string (excluding LOB) types.

fn as_i32(&self) -> Result<i32>

Gets the SQL value as i32. The Oracle type must be numeric or string (excluding LOB) types.

fn as_i64(&self) -> Result<i64>

Gets the SQL value as i64. The Oracle type must be numeric or string (excluding LOB) types.

fn as_u8(&self) -> Result<u8>

Gets the SQL value as u8. The Oracle type must be numeric or string (excluding LOB) types.

fn as_u16(&self) -> Result<u16>

Gets the SQL value as u16. The Oracle type must be numeric or string (excluding LOB) types.

fn as_u32(&self) -> Result<u32>

Gets the SQL value as u32. The Oracle type must be numeric or string (excluding LOB) types.

fn as_u64(&self) -> Result<u64>

Gets the SQL value as u64. The Oracle type must be numeric or string (excluding LOB) types.

fn as_f32(&self) -> Result<f32>

Gets the SQL value as f32. The Oracle type must be numeric or string (excluding LOB) types.

fn as_f64(&self) -> Result<f64>

Gets the SQL value as f64. The Oracle type must be numeric or string (excluding LOB) types.

fn as_string(&self) -> Result<String>

Gets the SQL value as string. ...

fn as_bytes(&self) -> Result<Vec<u8>>

Gets the SQL value as Vec<u8>. ...

fn as_timestamp(&self) -> Result<Timestamp>

Gets the SQL value as Timestamp. The Oracle type must be DATE, TIMESTAMP, or TIMESTAMP WITH TIME ZONE.

fn as_interval_ds(&self) -> Result<IntervalDS>

Gets the SQL value as IntervalDS. The Oracle type must be INTERVAL DAY TO SECOND.

fn as_interval_ym(&self) -> Result<IntervalYM>

Gets the SQL value as IntervalYM. The Oracle type must be INTERVAL YEAR TO MONTH.

fn as_bool(&self) -> Result<bool>

Gets the SQL value as bool. The Oracle type must be BOOLEAN(PL/SQL only).

fn set_i8(&mut self, val: &i8) -> Result<()>

Sets i8 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_i16(&mut self, val: &i16) -> Result<()>

Sets i16 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_i32(&mut self, val: &i32) -> Result<()>

Sets i32 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_i64(&mut self, val: &i64) -> Result<()>

Sets i64 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_u8(&mut self, val: &u8) -> Result<()>

Sets u8 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_u16(&mut self, val: &u16) -> Result<()>

Sets u16 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_u32(&mut self, val: &u32) -> Result<()>

Sets u32 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_u64(&mut self, val: &u64) -> Result<()>

Sets u64 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_f32(&mut self, val: &f32) -> Result<()>

Sets f32 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_f64(&mut self, val: &f64) -> Result<()>

Sets f64 to the SQL value. The Oracle type must be numeric or string (excluding LOB) types.

fn set_string(&mut self, val: &str) -> Result<()>

Sets &str to the SQL value. ...

fn set_bytes(&self, val: &Vec<u8>) -> Result<()>

Sets Vec<u8> to the SQL value. ...

fn set_timestamp(&self, val: &Timestamp) -> Result<()>

Sets Timestamp to the SQL value. The Oracle type must be DATE, TIMESTAMP, or TIMESTAMP WITH TIME ZONE.

fn set_interval_ds(&self, val: &IntervalDS) -> Result<()>

Sets IntervalDS to the SQL value. The Oracle type must be INTERVAL DAY TO SECOND.

fn set_interval_ym(&self, val: &IntervalYM) -> Result<()>

Sets IntervalYM to the SQL value. The Oracle type must be INTERVAL YEAR TO MONTH.

fn set_bool(&mut self, val: &bool) -> Result<()>

Sets boolean to the SQL value. The Oracle type must be BOOLEAN(PL/SQL only).

Trait Implementations

impl Display for SqlValue

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

Formats the value using the given formatter.

impl Clone for SqlValue

fn clone(&self) -> SqlValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for SqlValue

fn drop(&mut self)

Executes the destructor for this type.