Enum ActiveValue 

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

The state of one attribute of an active model.

Variants

Set(T)

A new value that will be written on the next insert or update.

Unchanged(T)

The value currently stored; it is read back but never written.

NotSet

No value; the database default applies on insert.

Implementations

impl<T> ActiveValue<T>

pub fn is_set(&self) -> bool

Whether the attribute is Set.

pub fn is_unchanged(&self) -> bool

Whether the attribute is Unchanged.

pub fn is_not_set(&self) -> bool

Whether the attribute is NotSet.

pub fn as_ref(&self) -> Option<&T>

The value, whether Set or Unchanged.

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

Takes the value out, leaving NotSet behind.

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

Consumes the attribute and returns its value, whether Set or Unchanged.

pub fn reset(&mut self)

Marks the attribute Unchanged, keeping its value; used after a successful write.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> ActiveValue<U>

Maps the inner value, preserving the attribute state.

impl<T: PartialEq> ActiveValue<T>

pub fn set_if_not_equals(&mut self, value: T)

Sets value unless it equals the current Unchanged value, in which case the attribute stays Unchanged and is not written back.

Trait Implementations

impl<T: Clone> Clone for ActiveValue<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ActiveValue<T>

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

Formats the value using the given formatter.

impl<T> Default for ActiveValue<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq> Eq for ActiveValue<T>

impl<T> From<T> for ActiveValue<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for ActiveValue<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for ActiveValue<T>