Struct mongodb::options::FindOneOptions [−][src]
#[non_exhaustive]pub struct FindOneOptions {}Show fields
pub allow_partial_results: Option<bool>, pub collation: Option<Collation>, pub comment: Option<String>, pub hint: Option<Hint>, pub max: Option<Document>, pub max_scan: Option<u64>, pub max_time: Option<Duration>, pub min: Option<Document>, pub projection: Option<Document>, pub read_concern: Option<ReadConcern>, pub return_key: Option<bool>, pub selection_criteria: Option<SelectionCriteria>, pub show_record_id: Option<bool>, pub skip: Option<u64>, pub sort: Option<Document>,
Expand description
Specifies the options to a Collection::find_one
operation.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct {{ .. }}
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.allow_partial_results: Option<bool>
Expand description
If true, partial results will be returned from a mongos rather than an error being returned if one or more shards is down.
collation: Option<Collation>
Expand description
The collation to use for the operation.
See the documentation for more information on how to use this option.
comment: Option<String>
Expand description
Tags the query with an arbitrary string to help trace the operation through the database profiler, currentOp and logs.
hint: Option<Hint>
Expand description
The index to use for the operation.
max: Option<Document>
Expand description
The exclusive upper bound for a specific index.
max_scan: Option<u64>
Expand description
Maximum number of documents or index keys to scan when executing the query.
Note: this option is deprecated starting in MongoDB version 4.0 and removed in MongoDB 4.2. Use the maxTimeMS option instead.
max_time: Option<Duration>
Expand description
The maximum amount of time to allow the query to run.
This options maps to the maxTimeMS
MongoDB query option, so the duration will be sent
across the wire as an integer number of milliseconds.
min: Option<Document>
Expand description
The inclusive lower bound for a specific index.
projection: Option<Document>
Expand description
Limits the fields of the document being returned.
read_concern: Option<ReadConcern>
Expand description
The read concern to use for this find query.
If none specified, the default set on the collection will be used.
return_key: Option<bool>
Expand description
Whether to return only the index keys in the documents.
selection_criteria: Option<SelectionCriteria>
Expand description
The criteria used to select a server for this find query.
If none specified, the default set on the collection will be used.
show_record_id: Option<bool>
Expand description
Whether to return the record identifier for each document.
skip: Option<u64>
Expand description
The number of documents to skip before counting.
sort: Option<Document>
Expand description
The order of the documents for the purposes of the operation.
Implementations
impl FindOneOptions
[src]
impl FindOneOptions
[src]pub fn builder(
) -> FindOneOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>
[src]
pub fn builder(
) -> FindOneOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>
[src]Create a builder for building FindOneOptions
.
On the builder, call .allow_partial_results(...)
(optional), .collation(...)
(optional), .comment(...)
(optional), .hint(...)
(optional), .max(...)
(optional), .max_scan(...)
(optional), .max_time(...)
(optional), .min(...)
(optional), .projection(...)
(optional), .read_concern(...)
(optional), .return_key(...)
(optional), .selection_criteria(...)
(optional), .show_record_id(...)
(optional), .skip(...)
(optional), .sort(...)
(optional) to set the values of the fields.
Finally, call .build()
to create the instance of FindOneOptions
.
Trait Implementations
impl Clone for FindOneOptions
[src]
impl Clone for FindOneOptions
[src]fn clone(&self) -> FindOneOptions
[src]
fn clone(&self) -> FindOneOptions
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for FindOneOptions
[src]
impl Debug for FindOneOptions
[src]impl Default for FindOneOptions
[src]
impl Default for FindOneOptions
[src]fn default() -> FindOneOptions
[src]
fn default() -> FindOneOptions
[src]Returns the “default value” for a type. Read more
impl<'de> Deserialize<'de> for FindOneOptions
[src]
impl<'de> Deserialize<'de> for FindOneOptions
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl From<FindOneOptions> for FindOptions
[src]
impl From<FindOneOptions> for FindOptions
[src]fn from(options: FindOneOptions) -> Self
[src]
fn from(options: FindOneOptions) -> Self
[src]Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for FindOneOptions
impl Send for FindOneOptions
impl Sync for FindOneOptions
impl Unpin for FindOneOptions
impl !UnwindSafe for FindOneOptions
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,