Module ldap3::controls
[−]
[src]
Control construction and parsing.
A control can be associated with a request or a response. Several common
controls, such as PagedResults
, are implemented
directly by this library. If an implemented control has the same form for
the request and the response, there will be a single structure for both.
(This is the case for PagedResults
.) If the response control is different,
its name will consist of the request control name with the Resp
suffix.
A request control can be created by instantiating its structure and converting
it to ASN.1 with into()
when passing the instance or constructing the request
control vector in the call to with_controls()
.
A third-party control must implement the conversion from an instance
of itself to RawControl
, a general form of control.
RawControl
, together with an optional instance of ControlType
, forms the type Control
; a vector
of Control
s is part of the result of all LDAP operation which return one.
The first element of Control
will have a value if the parser recognizes
the control's OID as one that is implemented by the library itself. Since the
list of implemented controls is expected to grow, matching those values must
be done through reexported types in the types
module,
and cannot be exhaustive.
A recognized response control can be parsed by calling parse()
on the instance of RawControl
representing it.
A third-party control must implement the ControlParser
trait to support this interface.
Modules
types |
Control type enum and variant names. |
Structs
Assertion |
Assertion control (RFC 4528). |
Control |
Response control. |
CriticalControl |
Wrapper for a control marked as critical. |
PagedResults |
Paged Results control (RFC 2696). |
PostRead |
Post-Read request control (RFC 4527). |
PreRead |
Pre-Read request control (RFC 4527). |
ProxyAuth |
Proxy Authorization control (RFC 4370). |
RawControl |
Generic control. |
ReadEntryResp |
Response for Pre-Read and Post-Read controls. |
RelaxRules |
Relax Rules control (draft specification). |
Traits
ControlParser |
Conversion trait for response controls. |
MakeCritical |
Mark a control as critical. |
Type Definitions
PostReadResp |
Type alias for Post-Read response. |
PreReadResp |
Type alias for Pre-Read response. |