Struct mongodb::sync::SessionCursor

pub struct SessionCursor<T> where
    T: DeserializeOwned + Unpin,  { /* fields omitted */ }

This is supported on crate feature sync only.

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

impl<T> SessionCursor<T> where
    T: DeserializeOwned + Unpin + Send + Sync, 

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.

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

impl<T: Debug> Debug for SessionCursor<T> where
    T: DeserializeOwned + Unpin, 

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

Formats the value using the given formatter.