Struct Name

pub struct Name { /* private fields */ }

Represents a DynamoDB attribute name. This will most commonly be used for top-level attributes.

This must only be used an attribute name without an index or additional field.

When used in an Expression, attribute Names are automatically handled as expression attribute names, allowing for names that would not otherwise be permitted by DynamoDB. For example, foo would become something similar to #0 in the expression, and the name would be in the expression_attribute_names.

use dynamodb_expression::path::Name;

// A variety of strings can be turned into a `Name`.
let name: Name = "foo".into();
let name: Name = String::from("foo").into();
let name: Name = (&String::from("foo")).into();
let name: Name = (&"foo").into();

Implementations

impl Name

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

where T: Into<String>,

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl From<&&str> for Name

fn from(name: &&str) -> Self

Converts to this type from the input type.

impl From<&String> for Name

fn from(name: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Name

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<Name> for Element

fn from(name: Name) -> Self

Converts to this type from the input type.

impl From<Name> for String

fn from(name: Name) -> Self

Converts to this type from the input type.

impl From<String> for Name

fn from(name: String) -> Self

Converts to this type from the input type.

impl Hash for Name

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Name

fn cmp(&self, other: &Name) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Name

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

fn partial_cmp(&self, other: &Name) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<Path> for Name

fn try_from(path: Path) -> Result<Self, Self::Error>

A Path consisting of a single, unindexed attribute can be converted into a Name.

let path: Path = "foo".parse().unwrap();
let name = Name::try_from(path).unwrap();
assert_eq!(Name::from("foo"), name);

If the Path has indexes, or has sub-attributes, it cannot be converted, and the original Path is returned.

let path: Path = "foo[0]".parse().unwrap();
let err = Name::try_from(path.clone()).unwrap_err();
assert_eq!(path, err);

let path: Path = "foo.bar".parse().unwrap();
let err = Name::try_from(path.clone()).unwrap_err();
assert_eq!(path, err);

type Error = Path

The type returned in the event of a conversion error.

impl Eq for Name

impl StructuralPartialEq for Name