Struct mongodb::options::FindOneOptions [−][src]
Specifies the options to a Collection::find_one
operation.
Fields (Non-exhaustive)
Struct {{ .. }}
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.allow_partial_results: Option<bool>
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>
The collation to use for the operation.
See the documentation for more information on how to use this option.
comment: Option<String>
Tags the query with an arbitrary string to help trace the operation through the database profiler, currentOp and logs.
hint: Option<Hint>
The index to use for the operation.
max: Option<Document>
The exclusive upper bound for a specific index.
max_scan: Option<i64>
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>
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>
The inclusive lower bound for a specific index.
projection: Option<Document>
Limits the fields of the document being returned.
read_concern: Option<ReadConcern>
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>
Whether to return only the index keys in the documents.
selection_criteria: Option<SelectionCriteria>
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>
Whether to return the record identifier for each document.
skip: Option<i64>
The number of documents to skip before counting.
sort: Option<Document>
The order of the documents for the purposes of the operation.
Implementations
impl FindOneOptions
[src]
pub fn builder(
) -> FindOneOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>
[src]
) -> FindOneOptionsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), (), ())>
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 (they accept Into
values).
Finally, call .build()
to create the instance of FindOneOptions
.
Trait Implementations
impl Clone for FindOneOptions
[src]
fn clone(&self) -> FindOneOptions
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for FindOneOptions
[src]
impl Default for FindOneOptions
[src]
fn default() -> FindOneOptions
[src]
impl<'de> Deserialize<'de> for FindOneOptions
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl From<FindOneOptions> for FindOptions
[src]
fn from(options: FindOneOptions) -> Self
[src]
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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,