Struct mongodb::sync::SessionCursor
source · pub struct SessionCursor<T> { /* private fields */ }
sync
or tokio-sync
only.Expand description
A SessionCursor
is a cursor that was created with a ClientSession
must be iterated using
one. To iterate, retrieve a [SessionCursorIter]
using SessionCursor::iter
:
for doc in cursor.iter(&mut session) {
println!("{}", doc?)
}
Implementations§
source§impl<T> SessionCursor<T>
impl<T> SessionCursor<T>
sourcepub fn advance(&mut self, session: &mut ClientSession) -> Result<bool>
pub fn advance(&mut self, session: &mut ClientSession) -> Result<bool>
Move the cursor forward, potentially triggering requests to the database for more results if the local buffer has been exhausted.
This will keep requesting data from the server until either the cursor is exhausted or batch with results in it has been received.
The return value indicates whether new results were successfully returned (true) or if the cursor has been closed (false).
Note: Cursor::current
and Cursor::deserialize_current
must only be called after
Cursor::advance
returned Ok(true)
. It is an error to call either of them without
calling Cursor::advance
first or after Cursor::advance
returns an error / false.
let mut cursor = coll.find_with_session(None, None, &mut session)?;
while cursor.advance(&mut session)? {
println!("{:?}", cursor.deserialize_current()?);
}
sourcepub fn current(&self) -> &RawDocument
pub fn current(&self) -> &RawDocument
Returns a reference to the current result in the cursor.
§Panics
Cursor::advance
must return Ok(true)
before Cursor::current
can be
invoked. Calling Cursor::current
after Cursor::advance
does not return true
or without calling Cursor::advance
at all may result in a panic.
let mut cursor = coll.find_with_session(None, None, &mut session)?;
while cursor.advance(&mut session)? {
println!("{:?}", cursor.current());
}
sourcepub fn deserialize_current<'a>(&'a self) -> Result<T>where
T: Deserialize<'a>,
pub fn deserialize_current<'a>(&'a self) -> Result<T>where
T: Deserialize<'a>,
Deserialize the current result to the generic type associated with this cursor.
§Panics
Cursor::advance
must return Ok(true)
before Cursor::deserialize_current
can be
invoked. Calling Cursor::deserialize_current
after Cursor::advance
does not return
true or without calling Cursor::advance
at all may result in a panic.
use serde::Deserialize;
#[derive(Debug, Deserialize)]
struct Cat<'a> {
#[serde(borrow)]
name: &'a str
}
let coll = db.collection::<Cat>("cat");
let mut cursor = coll.find_with_session(None, None, &mut session)?;
while cursor.advance(&mut session)? {
println!("{:?}", cursor.deserialize_current()?);
}
source§impl<T> SessionCursor<T>
impl<T> SessionCursor<T>
sourcepub fn iter<'session>(
&mut self,
session: &'session mut ClientSession
) -> SessionCursorIter<'_, 'session, T> ⓘ
pub fn iter<'session>( &mut self, session: &'session mut ClientSession ) -> SessionCursorIter<'_, 'session, T> ⓘ
Retrieves a SessionCursorIter
to iterate this cursor. The session provided must be
the same session used to create the cursor.
sourcepub fn next(&mut self, session: &mut ClientSession) -> Option<Result<T>>
pub fn next(&mut self, session: &mut ClientSession) -> Option<Result<T>>
Retrieve the next result from the cursor. The session provided must be the same session used to create the cursor.
Use this method when the session needs to be used again between iterations or when the added
functionality of Iterator
is not needed.
let mut cursor = coll.find_with_session(doc! { "x": 1 }, None, &mut session)?;
while let Some(doc) = cursor.next(&mut session).transpose()? {
other_coll.insert_one_with_session(doc, None, &mut session)?;
}
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for SessionCursor<T>
impl<T> !RefUnwindSafe for SessionCursor<T>
impl<T> Send for SessionCursor<T>where
T: Send,
impl<T> Sync for SessionCursor<T>where
T: Sync,
impl<T> Unpin for SessionCursor<T>where
T: Unpin,
impl<T> !UnwindSafe for SessionCursor<T>
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
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,
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,
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,
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,
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,
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,
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,
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,
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> 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,
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,
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,
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
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
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
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
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
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
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
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
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
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
.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
.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
.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
.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
.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
.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
.tap_deref()
only in debug builds, and is erased in release
builds.