1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
mod assign;
pub mod if_not_exists;
pub mod list_append;
pub mod math;
mod set_action;
pub use self::assign::Assign;
pub use self::if_not_exists::IfNotExists;
pub use self::list_append::ListAppend;
pub use self::math::Math;
pub use self::set_action::SetAction;
use core::fmt;
use super::set_remove::SetRemove;
/// Represents a [`SET` statement for an update expression][1]. Most of the time
/// you won't use this directly.
///
/// See also: [`Update`], [`Path::set`], [`Path::if_not_exists`], [`Path::math`]
/// [`Path::list_append`], [`Set::and`]
///
/// # Examples
///
/// ```
/// use dynamodb_expression::{Path, update::Set};
/// # use pretty_assertions::assert_eq;
///
/// let set = Set::from("foo".parse::<Path>().unwrap().math().add(1));
/// assert_eq!("SET foo = foo + 1", set.to_string());
///
/// let set_foo = Set::from("foo".parse::<Path>().unwrap().math().add(1));
/// assert_eq!("SET foo = foo + 1", set_foo.to_string());
///
/// let set_bar = Set::from("bar".parse::<Path>().unwrap().if_not_exists().set("a value"));
/// assert_eq!(r#"SET bar = if_not_exists(bar, "a value")"#, set_bar.to_string());
///
/// let set = set_foo.and(set_bar);
/// assert_eq!(
/// r#"SET foo = foo + 1, bar = if_not_exists(bar, "a value")"#,
/// set.to_string(),
/// );
///
/// let set = Set::from("foo".parse::<Path>().unwrap().list_append().list(["a", "b", "c"]));
/// assert_eq!(r#"SET foo = list_append(foo, ["a", "b", "c"])"#, set.to_string());
/// ```
///
/// [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html#Expressions.UpdateExpressions.SET
/// [`Update`]: crate::update::Update
/// [`Path::set`]: crate::path::Path::set
/// [`Path::if_not_exists`]: crate::path::Path::if_not_exists
/// [`Path::math`]: crate::path::Path::math
/// [`Path::list_append`]: crate::path::Path::list_append
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Set {
pub(crate) actions: Vec<SetAction>,
}
impl Set {
/// Add an additional [`Set`] or [`Remove`] statement to this expression.
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
/// use dynamodb_expression::{Num, Path, update::Set};
/// # use pretty_assertions::assert_eq;
///
/// let set = "foo"
/// .parse::<Path>()?
/// .set(Num::new(7))
/// .and("bar".parse::<Path>()?.set("a value"))
/// .and("baz".parse::<Path>()?.remove());
/// assert_eq!(r#"SET foo = 7, bar = "a value" REMOVE baz"#, set.to_string());
/// #
/// # Ok(())
/// # }
/// ```
///
/// [`Remove`]: crate::update::Remove
pub fn and<T>(self, other: T) -> SetRemove
where
T: Into<SetRemove>,
{
SetRemove::from(self).and(other)
}
}
impl fmt::Display for Set {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("SET ")?;
let mut first = true;
self.actions.iter().try_for_each(|action| {
if first {
first = false
} else {
f.write_str(", ")?;
}
action.fmt(f)
})
}
}
impl<T> From<T> for Set
where
T: Into<SetAction>,
{
fn from(value: T) -> Self {
Self {
actions: vec![value.into()],
}
}
}
impl<T> FromIterator<T> for Set
where
T: Into<SetAction>,
{
fn from_iter<I>(iter: I) -> Self
where
I: IntoIterator<Item = T>,
{
Self {
actions: iter.into_iter().map(Into::into).collect(),
}
}
}
#[cfg(test)]
mod test {
use pretty_assertions::assert_eq;
use crate::{update::set_remove::SetRemove, Num, Path};
use super::{Assign, IfNotExists, ListAppend, Math, Set, SetAction};
#[test]
fn from() -> Result<(), Box<dyn std::error::Error>> {
let assign: Assign = "foo".parse::<Path>()?.set(Num::new(8));
let if_not_exists: IfNotExists = "bar".parse::<Path>()?.if_not_exists().set(Num::new(7));
let math: Math = "baz".parse::<Path>()?.math().add(1);
let list_append: ListAppend = "quux".parse::<Path>()?.list_append().list(["d", "e", "f"]);
let _set = [
Set::from(assign.clone()),
Set::from(if_not_exists),
Set::from(math),
Set::from(list_append),
];
let _set = Set::from(SetAction::from(assign));
Ok(())
}
#[test]
fn and() -> Result<(), Box<dyn std::error::Error>> {
let assign: Assign = "bar".parse::<Path>()?.set(Num::new(8));
let set: Set = Set::from("foo".parse::<Path>()?.set("a value"));
// Should be able to concatenate anything that can be turned into a SetAction.
let combined = set.clone().and(assign.clone());
assert_eq!(r#"SET foo = "a value", bar = 8"#, combined.to_string());
// Should be able to concatenate a SetAction instance.
let combined = set.clone().and(SetAction::from(assign.clone()));
assert_eq!(r#"SET foo = "a value", bar = 8"#, combined.to_string());
// Should be able to concatenate a Set instance
let set_2: Set = [
SetAction::from(assign),
SetAction::from("baz".parse::<Path>()?.if_not_exists().set(Num::new(7))),
]
.into_iter()
.collect();
let combined = set.clone().and(set_2);
assert_eq!(
r#"SET foo = "a value", bar = 8, baz = if_not_exists(baz, 7)"#,
combined.to_string()
);
// Should be able to concatenate a Remove instance
let combined = set.clone().and("quux".parse::<Path>()?.remove());
assert_eq!(r#"SET foo = "a value" REMOVE quux"#, combined.to_string());
// Should be able to concatenate a SetRemove instance
let combined = set.and(SetRemove::from("quux".parse::<Path>()?.remove()));
assert_eq!(r#"SET foo = "a value" REMOVE quux"#, combined.to_string());
Ok(())
}
}