Struct sea_orm::entity::ActiveValue

pub struct ActiveValue<V> where
    V: Into<Value>,  { /* fields omitted */ }

Defines a value from an ActiveModel and its state. The field value takes in an Option type where Option::Some(V) , with V holding the value that operations like UPDATE are being performed on and the state field is either ActiveValueState::Set or ActiveValueState::Unchanged. Option::None in the value field indicates no value being performed by an operation and that the state field of the ActiveValue is set to ActiveValueState::Unset .

Example snippet

// The code snipped below does an UPDATE operation on a [ActiveValue]
// yielding the the SQL statement ` r#"UPDATE "fruit" SET "name" = 'Orange' WHERE "fruit"."id" = 1"# `

use sea_orm::tests_cfg::{cake, fruit};
use sea_orm::{entity::*, query::*, DbBackend};

Update::one(fruit::ActiveModel {
    id: ActiveValue::set(1),
    name: ActiveValue::set("Orange".to_owned()),
    cake_id: ActiveValue::unset(),
})
.build(DbBackend::Postgres)
.to_string();

Implementations

impl<V> ActiveValue<V> where
    V: Into<Value>, 

pub fn set(value: V) -> Self

Set the value of an ActiveValue and also set its state to ActiveValueState::Set

pub fn is_set(&self) -> bool

Check if the state of an ActiveValue is ActiveValueState::Set which returns true

pub fn is_unchanged(&self) -> bool

Check if the status of the ActiveValue is ActiveValueState::Unchanged which returns true if it is

pub fn unset() -> Self

Set the value field of the ActiveModel to Option::None and the state field to ActiveValueState::Unset

pub fn is_unset(&self) -> bool

Check if the state of an ActiveValue is ActiveValueState::Unset which returns true if it is

pub fn take(&mut self) -> Option<V>

Get the mutable value of the value field of an ActiveValue also setting it’s state to ActiveValueState::Unset

pub fn unwrap(self) -> V

Get an owned value of the value field of the ActiveValue

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

Check is a Value exists or not

pub fn into_wrapped_value(self) -> ActiveValue<Value>

Wrap the Value into a ActiveValue<Value>

Trait Implementations

impl<V> AsRef<V> for ActiveValue<V> where
    V: Into<Value>, 

fn as_ref(&self) -> &V

Performs the conversion.

impl<V: Clone> Clone for ActiveValue<V> where
    V: Into<Value>, 

fn clone(&self) -> ActiveValue<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for ActiveValue<V> where
    V: Into<Value>, 

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

Formats the value using the given formatter.

impl<V: Default> Default for ActiveValue<V> where
    V: Into<Value>, 

fn default() -> ActiveValue<V>

Returns the “default value” for a type.

impl<V> From<ActiveValue<V>> for ActiveValue<Option<V>> where
    V: Into<Value> + Nullable, 

fn from(value: ActiveValue<V>) -> Self

Performs the conversion.

impl<V> PartialEq<ActiveValue<V>> for ActiveValue<V> where
    V: Into<Value> + PartialEq, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.