Struct ldap3::EntryStream

pub struct EntryStream<'a, 'b, S, A> { /* private fields */ }

Available on crate feature sync only.

Handle for obtaining a stream of search results.

User code can’t construct a stream directly, but only by using streaming_search() or streaming_search_with() on an LdapConn handle.

For compatibility, this struct’s name is different from the async version which is SearchStream. The protocol and behavior are the same, with one important difference: an EntryStream shares the Tokio runtime with LdapConn from which it’s obtained, but the two can’t be used in parallel, which is enforced by capturing the reference to LdapConn during the lifetime of EntryStream.

Implementations

impl<'a, 'b, S, A> EntryStream<'a, 'b, S, A>where S: AsRef<str> + Send + Sync + 'a, A: AsRef<[S]> + Send + Sync + 'a,

pub fn next(&mut self) -> Result<Option<ResultEntry>>

See SearchStream::next().

pub fn result(self) -> LdapResult

See SearchStream::finish().

The name result() was kept for backwards compatibility.

pub fn last_id(&mut self) -> RequestId

Returns the Message ID of the initial Search.

This method calls Ldap::last_id() on the Ldap handle encapsulated by the underlying stream.