Enum SetOption

pub enum SetOption<T> {
    Set(T),
    NotSet,
}

tiny_orm::SetOption is an enum that behave similarly to Option in the sense that there are only two variants. The goal is to easily differentiate between an Option type and a SetOption type. So that it is possible to have a struct like the following

struct Todo {
    id: SetOption<i64>,
    description: SetOption<Option<String>>,
}

When the variant will be SetOption::NotSet, then tiny ORM will automatically skip the field during “write” operations like create() or update().

Variants

Set(T)

NotSet

Implementations

impl<T> SetOption<T>

pub fn inner(self) -> Option<T>

inner() is a method to get the inner value as an Option type. This return an Option<T> type where Some<T> corresponds to the Set variant,

Examples

let set = SetOption::Set(1);
let inner = set.inner();
assert_eq!(inner, Some(1));

let not_set: SetOption<i32> = SetOption::NotSet;
let inner = not_set.inner();
assert_eq!(inner, None);

pub fn value(self) -> Result<T, TinyOrmError>

value() is a method to get the inner value as an Result type. This return an Result<T, TinyOrmError> type where Ok<T> corresponds to the Set variant,

Examples

let set = SetOption::Set(1);
let inner = set.value();
assert_eq!(inner, Ok(1));

use tiny_orm_model::{SetOption, TinyOrmError};
let not_set: SetOption<i32> = SetOption::NotSet;
let inner = not_set.value();
assert_eq!(inner, Err(TinyOrmError::SetOptionNotSet));

pub fn is_set(&self) -> bool

is_set() returns true if the variant is Set

Examples

let set = SetOption::Set(1);
assert!(set.is_set());

let not_set: SetOption<i32> = SetOption::NotSet;
assert!(!not_set.is_set());

pub fn is_not_set(&self) -> bool

is_not_set() returns true if the variant is NotSet

Examples

let set = SetOption::Set(1);
assert!(!set.is_not_set());

let not_set: SetOption<i32> = SetOption::NotSet;
assert!(not_set.is_not_set());

Trait Implementations

impl<T> Clone for SetOption<T>

where T: Clone,

fn clone(&self) -> SetOption<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SetOption<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'r, DB, T> Decode<'r, DB> for SetOption<T>

where DB: Database, T: Decode<'r, DB>,

Implements database decoding for SetOption<T>. This allows automatic conversion from database values to SetOption<T>.

Examples

#[derive(FromRow)]
struct TestRecord {
    value: SetOption<i32>,
}

let pool = SqlitePool::connect("sqlite::memory:").await.unwrap();



// Test with a value
let record: TestRecord = sqlx::query_as("SELECT value FROM test")
    .fetch_one(&pool)
    .await
    .unwrap();

assert_eq!(record.value, SetOption::Set(42));

// Test NULL value

let record: TestRecord = sqlx::query_as("SELECT value FROM test")
    .fetch_one(&pool)
    .await
    .unwrap();

assert_eq!(record.value, SetOption::NotSet);

fn decode( value: <DB as Database>::ValueRef<'r>, ) -> Result<SetOption<T>, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl<T> Default for SetOption<T>

fn default() -> SetOption<T>

Returns the “default value” for a type.

impl<'q, T, DB> Encode<'q, DB> for SetOption<T>

where DB: Database, T: Encode<'q, DB>,

Implements database encoding for SetOption<T>. This allows automatic conversion from SetOption<T> to database values.

Examples

#[derive(FromRow)]
struct TestRecord {
    value: SetOption<i32>,
}

let pool = SqlitePool::connect("sqlite::memory:").await.unwrap();

// Create test table
sqlx::query("CREATE TABLE test (value INTEGER)")
    .execute(&pool)
    .await
    .unwrap();

// Test inserting a Set value
let set_value = SetOption::Set(42);
sqlx::query("INSERT INTO test (value) VALUES (?)")
    .bind(set_value)
    .execute(&pool)
    .await
    .unwrap();

let record: TestRecord = sqlx::query_as("SELECT value FROM test")
    .fetch_one(&pool)
    .await
    .unwrap();
assert_eq!(record.value, SetOption::Set(42));

// Test inserting a NotSet value
sqlx::query("DELETE FROM test").execute(&pool).await.unwrap();
let not_set_value: SetOption<i32> = SetOption::NotSet;
sqlx::query("INSERT INTO test (value) VALUES (?)")
    .bind(not_set_value)
    .execute(&pool)
    .await
    .unwrap();

let record: TestRecord = sqlx::query_as("SELECT value FROM test")
    .fetch_one(&pool)
    .await
    .unwrap();
assert_eq!(record.value, SetOption::NotSet);

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf in the expected format for the database.

fn encode_by_ref( &self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

Writes the value of self into buf without moving self.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl<T> From<T> for SetOption<T>

Implement From for SetOption to allow for easy conversion from a value to a SetOption.

let set_option: SetOption<i32> = 1.into();
assert_eq!(set_option, SetOption::Set(1));

fn from(value: T) -> SetOption<T>

Converts to this type from the input type.

impl<T> Hash for SetOption<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for SetOption<T>

where T: Ord,

fn cmp(&self, other: &SetOption<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for SetOption<T>

where T: PartialEq,

fn eq(&self, other: &SetOption<T>) -> 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<T> PartialOrd for SetOption<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &SetOption<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<DB, T> Type<DB> for SetOption<T>

where DB: Database, T: Type<DB>,

fn type_info() -> <DB as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl<T> Eq for SetOption<T>

where T: Eq,

impl<T> StructuralPartialEq for SetOption<T>