Skip to main content

ScanInput

Struct ScanInput 

Source
pub struct ScanInput {
Show 16 fields pub table_name: String, pub index_name: Option<String>, pub filter_expression: Option<String>, pub projection_expression: Option<String>, pub expression_attribute_names: HashMap<String, String>, pub expression_attribute_values: HashMap<String, AttributeValue>, pub limit: Option<i32>, pub exclusive_start_key: HashMap<String, AttributeValue>, pub segment: Option<i32>, pub total_segments: Option<i32>, pub select: Option<Select>, pub consistent_read: Option<bool>, pub return_consumed_capacity: Option<ReturnConsumedCapacity>, pub scan_filter: HashMap<String, Condition>, pub attributes_to_get: Option<Vec<String>>, pub conditional_operator: Option<ConditionalOperator>,
}
Expand description

Input for the Scan operation.

Fields§

§table_name: String

The name of the table to scan.

§index_name: Option<String>

The name of a secondary index to scan.

§filter_expression: Option<String>

A string that contains conditions for filtering the scan results.

§projection_expression: Option<String>

A string that identifies the attributes to retrieve from the table.

§expression_attribute_names: HashMap<String, String>

Substitution tokens for attribute names in an expression.

§expression_attribute_values: HashMap<String, AttributeValue>

Substitution tokens for attribute values in an expression.

§limit: Option<i32>

The maximum number of items to evaluate.

§exclusive_start_key: HashMap<String, AttributeValue>

The primary key of the first item that this operation will evaluate. Used for pagination.

§segment: Option<i32>

For a parallel Scan request, identifies an individual segment to be scanned by an application worker.

§total_segments: Option<i32>

For a parallel Scan request, the total number of segments into which the table is divided.

§select: Option<Select>

The attributes to be returned in the result.

§consistent_read: Option<bool>

If true, a strongly consistent read is used.

§return_consumed_capacity: Option<ReturnConsumedCapacity>

Determines the level of detail about provisioned throughput consumption.

§scan_filter: HashMap<String, Condition>

Legacy: scan filter (use filter_expression instead).

§attributes_to_get: Option<Vec<String>>

Legacy: attribute names to retrieve (use projection_expression instead).

§conditional_operator: Option<ConditionalOperator>

Legacy: logical operator for combining multiple scan filter conditions.

Trait Implementations§

Source§

impl Clone for ScanInput

Source§

fn clone(&self) -> ScanInput

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 Debug for ScanInput

Source§

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

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

impl Default for ScanInput

Source§

fn default() -> ScanInput

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ScanInput

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ScanInput

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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, 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,