Crate ldap3

A pure-Rust LDAP library using the Tokio stack.

Usage

In Cargo.toml:

[dependencies.ldap3]
version = "0.4"

In the crate root:

extern crate ldap3;

Summary

Although the library provides both synchronous and asynchronous interfaces, presently the synchronous one is less likely to undergo breaking changes, and is the preferred way to use the library. The LdapConn structure is the starting point for all synchronous operations. LdapConnAsync is its asynchronous analogue, and Ldap is the low-level asynchronous connection handle used by both.

In the struct list, async-related structs have an asterisk (*) after the short description.

Since the library is still in development, none of the interfaces should be considered stable. If a breaking change of some component is planned, it will be noted in the documentation with a bolded Note, and a link to the GitHub issue discussing the change, if applicable. General, crate-level issues with the documentation can be discussed here.

The documentation is written for readers familiar with LDAP concepts and terminology, which it won't attempt to explain.

Modules

asn1	ASN.1 structure construction and parsing.
controls	Control construction and parsing.
exop	Extended operation construction and parsing.

Structs

EntryStream	Handle for obtaining a stream of search results.
Ldap	LDAP connection. *
LdapConn	Handle for LDAP operations. Entry point for the synchronous interface.
LdapConnAsync	Asynchronous handle for LDAP operations; analogue of LdapConn. *
LdapResult	Common components of an LDAP operation result.
SearchEntry	Parsed search result entry.
SearchOptions	Additional parameters for the Search operation.
SearchStream	Stream of search results. *

Enums

DerefAliases	Possible values for alias dereferencing during search.
Mod	Possible sub-operations for the Modify operation.
Scope	Possible values for search scope.