Struct Remove

pub struct Remove { /* private fields */ }

For use an in an update expression to remove attributes from an item, or elements from a list.

Prefer Path::remove over this.

See also: Update

Examples

use dynamodb_expression::{Expression, Path, update::{Remove, Update}};

let remove = "foo".parse::<Path>()?.remove();
assert_eq!("REMOVE foo", remove.to_string());

let remove = Remove::from("foo[8]".parse::<Path>()?);
assert_eq!("REMOVE foo[8]", remove.to_string());

let remove: Remove = ["foo", "bar", "baz"].into_iter().map(Path::new_name).collect();
assert_eq!("REMOVE foo, bar, baz", remove.to_string());

let remove = remove.and("quux".parse::<Path>()?.remove());
assert_eq!("REMOVE foo, bar, baz, quux", remove.to_string());

// Use in an update expression
let update = Update::from(remove.clone());

// Use an expression builder
let expression = Expression::builder().with_update(remove).build();

Implementations

impl Remove

pub fn and<T>(self, other: T) -> Update

where T: Into<Update>,

Add an additional Update statement to this expression.

use dynamodb_expression::Path;

let remove = "foo".parse::<Path>()?.remove().and("bar".parse::<Path>()?.remove());
assert_eq!("REMOVE foo, bar", remove.to_string());

let set_remove = remove.and("baz".parse::<Path>()?.set("a value"));
assert_eq!(r#"SET baz = "a value" REMOVE foo, bar"#, set_remove.to_string());

Trait Implementations

impl Clone for Remove

fn clone(&self) -> Remove

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Remove

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

Formats the value using the given formatter.

impl Display for Remove

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

Formats the value using the given formatter.

impl From<Remove> for Update

fn from(value: Remove) -> Self

Converts to this type from the input type.

impl<T> From<T> for Remove

where T: Into<Path>,

fn from(path: T) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Remove

where T: Into<Path>,

fn from_iter<I>(paths: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl PartialEq for Remove

fn eq(&self, other: &Remove) -> 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 Eq for Remove

impl StructuralPartialEq for Remove