Struct dynamodb_expression::update::remove::Remove

pub struct Remove { /* private fields */ }

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

See also: Path::remove, Update

Examples

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

let update = Remove::new_name("foo");
assert_eq!(r#"REMOVE foo"#, update.to_string());

let update = Remove::new_indexed_field("foo", [8]);
assert_eq!(r#"REMOVE foo[8]"#, update.to_string());

let update = Remove::from("foo[8]".parse::<Path>().unwrap());
assert_eq!(r#"REMOVE foo[8]"#, update.to_string());

let update = Remove::from_iter(["foo", "bar", "baz"].map(Path::new_name));
assert_eq!(r#"REMOVE foo, bar, baz"#, update.to_string());

Implementations

impl Remove

pub fn new_name<T>(name: T) -> Self

where T: Into<Name>,

Remove the specified top-level element.

See also: Name

pub fn new_indexed_field<N, I>(name: N, indexes: I) -> Self

where N: Into<Name>, I: Indexes,

Constructs a Remove for an indexed field element of a document path. For example, foo[3] or foo[7][4]. If you have a attribute name with no indexes, you can pass an empty collection, or use Remove::new_name.

indexes here can be an array, slice, Vec of, or single usize.

See also: IndexedField, Path::new_indexed_field

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 From<Remove> for Vec<Path>

fn from(remove: 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

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Remove

impl StructuralEq for Remove

impl StructuralPartialEq for Remove