Struct mongodb::action::ListIndexes
source · pub struct ListIndexes<'a, Mode = ListSpecifications, Session = ImplicitSession> { /* private fields */ }
Expand description
List indexes on a collection. Construct with Collection::list_indexes
or
Collection::list_index_names
.
Implementations§
source§impl<'a, Mode, Session> ListIndexes<'a, Mode, Session>
impl<'a, Mode, Session> ListIndexes<'a, Mode, Session>
sourcepub fn with_options(self, value: impl Into<Option<ListIndexesOptions>>) -> Self
pub fn with_options(self, value: impl Into<Option<ListIndexesOptions>>) -> Self
Set all options. Note that this will replace all previous values set.
sourcepub fn max_time(self, value: Duration) -> Self
pub fn max_time(self, value: Duration) -> Self
Set the ListIndexesOptions::max_time
option.
sourcepub fn batch_size(self, value: u32) -> Self
pub fn batch_size(self, value: u32) -> Self
Set the ListIndexesOptions::batch_size
option.
sourcepub fn comment(self, value: impl Into<Bson>) -> Self
pub fn comment(self, value: impl Into<Bson>) -> Self
Set the ListIndexesOptions::comment
option.
source§impl<'a, Mode> ListIndexes<'a, Mode, ImplicitSession>
impl<'a, Mode> ListIndexes<'a, Mode, ImplicitSession>
sourcepub fn session(
self,
value: impl Into<&'a mut ClientSession>,
) -> ListIndexes<'a, Mode, ExplicitSession<'a>>
pub fn session( self, value: impl Into<&'a mut ClientSession>, ) -> ListIndexes<'a, Mode, ExplicitSession<'a>>
Use the provided session when running the operation.
source§impl<'a> ListIndexes<'a, ListSpecifications, ImplicitSession>
impl<'a> ListIndexes<'a, ListSpecifications, ImplicitSession>
sourcepub fn run(self) -> Result<Cursor<IndexModel>>
Available on crate feature sync
only.
pub fn run(self) -> Result<Cursor<IndexModel>>
sync
only.Synchronously execute this action.
source§impl<'a> ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
impl<'a> ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
sourcepub fn run(self) -> Result<SessionCursor<IndexModel>>
Available on crate feature sync
only.
pub fn run(self) -> Result<SessionCursor<IndexModel>>
sync
only.Synchronously execute this action.
source§impl<'a> ListIndexes<'a, ListNames, ImplicitSession>
impl<'a> ListIndexes<'a, ListNames, ImplicitSession>
source§impl<'a> ListIndexes<'a, ListNames, ExplicitSession<'a>>
impl<'a> ListIndexes<'a, ListNames, ExplicitSession<'a>>
Trait Implementations§
source§impl<'a> Action for ListIndexes<'a, ListSpecifications, ImplicitSession>
impl<'a> Action for ListIndexes<'a, ListSpecifications, ImplicitSession>
source§impl<'a> Action for ListIndexes<'a, ListNames, ImplicitSession>
impl<'a> Action for ListIndexes<'a, ListNames, ImplicitSession>
source§impl<'a> Action for ListIndexes<'a, ListNames, ExplicitSession<'a>>
impl<'a> Action for ListIndexes<'a, ListNames, ExplicitSession<'a>>
source§impl<'a> Action for ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
impl<'a> Action for ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
source§impl<'a> IntoFuture for ListIndexes<'a, ListSpecifications, ImplicitSession>
impl<'a> IntoFuture for ListIndexes<'a, ListSpecifications, ImplicitSession>
source§type Output = Result<Cursor<IndexModel>, Error>
type Output = Result<Cursor<IndexModel>, Error>
The output that the future will produce on completion.
source§type IntoFuture = ListIndexesFuture<'a>
type IntoFuture = ListIndexesFuture<'a>
Which kind of future are we turning this into?
source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
source§impl<'a> IntoFuture for ListIndexes<'a, ListNames, ImplicitSession>
impl<'a> IntoFuture for ListIndexes<'a, ListNames, ImplicitSession>
source§type Output = Result<Vec<String>, Error>
type Output = Result<Vec<String>, Error>
The output that the future will produce on completion.
source§type IntoFuture = ListIndexNamesFuture<'a>
type IntoFuture = ListIndexNamesFuture<'a>
Which kind of future are we turning this into?
source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
source§impl<'a> IntoFuture for ListIndexes<'a, ListNames, ExplicitSession<'a>>
impl<'a> IntoFuture for ListIndexes<'a, ListNames, ExplicitSession<'a>>
source§type Output = Result<Vec<String>, Error>
type Output = Result<Vec<String>, Error>
The output that the future will produce on completion.
source§type IntoFuture = ListIndexNamesSessionFuture<'a>
type IntoFuture = ListIndexNamesSessionFuture<'a>
Which kind of future are we turning this into?
source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
source§impl<'a> IntoFuture for ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
impl<'a> IntoFuture for ListIndexes<'a, ListSpecifications, ExplicitSession<'a>>
source§type Output = Result<SessionCursor<IndexModel>, Error>
type Output = Result<SessionCursor<IndexModel>, Error>
The output that the future will produce on completion.
source§type IntoFuture = ListIndexesSessionFuture<'a>
type IntoFuture = ListIndexesSessionFuture<'a>
Which kind of future are we turning this into?
source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
Auto Trait Implementations§
impl<'a, Mode, Session> Freeze for ListIndexes<'a, Mode, Session>where
Session: Freeze,
impl<'a, Mode = ListSpecifications, Session = ImplicitSession> !RefUnwindSafe for ListIndexes<'a, Mode, Session>
impl<'a, Mode, Session> Send for ListIndexes<'a, Mode, Session>
impl<'a, Mode, Session> Sync for ListIndexes<'a, Mode, Session>
impl<'a, Mode, Session> Unpin for ListIndexes<'a, Mode, Session>
impl<'a, Mode = ListSpecifications, Session = ImplicitSession> !UnwindSafe for ListIndexes<'a, Mode, Session>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.