Skip to main content

UpdateSetRhs

Struct UpdateSetRhs 

Source
pub struct UpdateSetRhs<'a>(/* private fields */);
Expand description

Advanced right-hand-side expression builder for DynamoDB SET actions.

UpdateSetRhs<'a> represents the right-hand side of a SET attr = <rhs> expression. It is used with Update::set_custom when the simple Update::set shorthand is insufficient — for example, when you need to reference another attribute, use if_not_exists, or build complex arithmetic expressions.

UpdateSetRhs values can be combined with + and - to ease building of arithmetic expressions:

use dynamodb_facade::{Update, UpdateSetRhs};

// SET score = other_score + 10
let rhs = UpdateSetRhs::attr("other_score") + UpdateSetRhs::value(10);
let update = Update::set_custom("score", rhs);
assert_eq!(format!("{update}"), r#"SET score = other_score + N("10")"#);

// SET balance = base_balance - penalty
let rhs = UpdateSetRhs::attr("base_balance") - UpdateSetRhs::attr("penalty");
let update = Update::set_custom("balance", rhs);
assert_eq!(format!("{update}"), "SET balance = base_balance - penalty");

Implementations§

Source§

impl<'a> UpdateSetRhs<'a>

Source

pub fn value(value: impl IntoAttributeValue) -> Self

Creates an RHS that reference a literal value.

This is the simplest form. For most cases, Update::set is more ergonomic and equivalent.

§Examples
use dynamodb_facade::{Update, UpdateSetRhs};

let update = Update::set_custom("score", UpdateSetRhs::value(100));
assert_eq!(format!("{update}"), r#"SET score = N("100")"#);

// Same as Update::set
let update = Update::set("score", 100);
assert_eq!(format!("{update}"), r#"SET score = N("100")"#);
Source

pub fn attr(attr: impl Into<Cow<'a, str>>) -> Self

Creates an RHS that references another attribute by name.

Use this to copy one attribute’s value to another, or as part of an arithmetic expression.

§Examples
use dynamodb_facade::{Update, UpdateSetRhs};

// SET old_score = current_score
let update = Update::set_custom("old_score", UpdateSetRhs::attr("current_score"));
assert_eq!(format!("{update}"), "SET old_score = current_score");
Source

pub fn if_not_exists( attr: impl Into<Cow<'a, str>>, value: impl IntoAttributeValue, ) -> Self

Creates an RHS using if_not_exists(attr, default).

Evaluates to the current value of attr if it exists, or default otherwise. Useful for initializing an attribute on first write without overwriting an existing value.

§Examples
use dynamodb_facade::{Update, UpdateSetRhs};

// SET old_score = if_not_exists(score, 0)
let update = Update::set_custom(
    "old_score",
    UpdateSetRhs::if_not_exists("score", 0),
);
assert_eq!(
    format!("{update}"),
    r#"SET old_score = if_not_exists(score, N("0"))"#
);

Trait Implementations§

Source§

impl<'a> Add for UpdateSetRhs<'a>

Combines two RHS expressions with addition: expr1 + expr2.

Produces a expr1 + expr2 arithmetic expression fragment for use in a SET action.

§Examples

use dynamodb_facade::{Update, UpdateSetRhs};

// SET score = base_score + 10
let update = Update::set_custom(
    "score",
    UpdateSetRhs::attr("base_score") + UpdateSetRhs::value(10),
);
assert_eq!(format!("{update}"), r#"SET score = base_score + N("10")"#);

// SET balance = base_balance + last_payment
let rhs = UpdateSetRhs::attr("base_balance") + UpdateSetRhs::attr("last_payment");
let update = Update::set_custom("balance", rhs);
assert_eq!(format!("{update}"), "SET balance = base_balance + last_payment");
Source§

type Output = UpdateSetRhs<'a>

The resulting type after applying the + operator.
Source§

fn add(self, rhs: UpdateSetRhs<'a>) -> Self::Output

Performs the + operation. Read more
Source§

impl<'a> Clone for UpdateSetRhs<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for UpdateSetRhs<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Sub for UpdateSetRhs<'a>

Combines two RHS expressions with subtraction: expr1 - expr2.

Produces a expr1 - expr2 arithmetic expression fragment for use in a SET action.

§Examples

use dynamodb_facade::{Update, UpdateSetRhs};

// SET balance = base_balance - 5
let update = Update::set_custom(
    "balance",
    UpdateSetRhs::attr("base_balance") - UpdateSetRhs::value(5),
);
assert_eq!(format!("{update}"), r#"SET balance = base_balance - N("5")"#);

// SET balance = base_balance - penalty
let rhs = UpdateSetRhs::attr("base_balance") - UpdateSetRhs::attr("penalty");
let update = Update::set_custom("balance", rhs);
assert_eq!(format!("{update}"), "SET balance = base_balance - penalty");
Source§

type Output = UpdateSetRhs<'a>

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: UpdateSetRhs<'a>) -> Self::Output

Performs the - operation. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for UpdateSetRhs<'a>

§

impl<'a> RefUnwindSafe for UpdateSetRhs<'a>

§

impl<'a> Send for UpdateSetRhs<'a>

§

impl<'a> Sync for UpdateSetRhs<'a>

§

impl<'a> Unpin for UpdateSetRhs<'a>

§

impl<'a> UnsafeUnpin for UpdateSetRhs<'a>

§

impl<'a> UnwindSafe for UpdateSetRhs<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more