Struct SearchRequest 

#[non_exhaustive]
pub struct SearchRequest {
    pub base_object: LdapDn,
    pub scope: SearchRequestScope,
    pub deref_aliases: SearchRequestDerefAliases,
    pub size_limit: u32,
    pub time_limit: u32,
    pub types_only: bool,
    pub filter: Filter,
    pub attributes: AttributeSelection,
}

Used to request a server to return, subject to access controls and other restrictions, a set of entries matching a complex search criterion.

This can be used to read attributes from a single entry, from entries immediately subordinate to a particular entry, or from a whole subtree of entries.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_object: LdapDn

The name of the base object entry (or possibly the root) relative to which the search is to be performed.

scope: SearchRequestScope

The scope of the search to be performed.

deref_aliases: SearchRequestDerefAliases

An indicator as to whether or not alias entries are to be dereferenced during stages of the search operation.

size_limit: u32

The maximum number of entries to be returned as a result of the search.

A value of zero in this field indicates that no client-requested time limit restrictions are in effect for the Search. Servers may also enforce a maximum number of entries to return.

time_limit: u32

The maximum time (in seconds) allowed for a search.

A value of zero in this field indicates that no client-requested time limit restrictions are in effect for the Search. Servers may also enforce a maximum time limit for the Search.

types_only: bool

Whether search results are to contain both attribute descriptions and values, or just attribute descriptions.

Setting this field to true causes only attribute descriptions (and not values) to be returned. Setting this field to false causes both attribute descriptions and values to be returned.

filter: Filter

Defines the conditions that must be fulfilled in order for the search to match a given entry.

attributes: AttributeSelection

A selection list of the attributes to be returned from each entry that matches the search filter.

Attributes that are subtypes of listed attributes are implicitly included.

Implementations

impl SearchRequest

pub fn new( base_object: LdapDn, scope: SearchRequestScope, deref_aliases: SearchRequestDerefAliases, size_limit: u32, time_limit: u32, types_only: bool, filter: Filter, attributes: AttributeSelection, ) -> Self

SearchRequest constructor

Trait Implementations

impl AsnType for SearchRequest

const TAG: Tag

The associated tag for the type.

const IDENTIFIER: Identifier

Identifier of an ASN.1 type as specified in the original specification if not identical with the identifier of Self

const CONSTRAINTS: Constraints

The set of constraints for values of the given type.

const TAG_TREE: TagTree = _

The root of this type’s tree of tag’s if it a CHOICE type, otherwise its Leaf that points Self::TAG.

const IS_CHOICE: bool = false

Whether the type is choice type. PER/OER encoding rules require this knowledge.

fn is_present(&self) -> bool

Whether the type is present with value. OPTIONAL fields are common in SEQUENCE or SET.

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Constructed<8> for SearchRequest

const FIELDS: Fields<8usize>

Fields contained in the “root component list”.

const IS_EXTENSIBLE: bool = true

Whether the type is extensible.

const EXTENDED_FIELDS: Option<Fields<0usize>> = None

Fields contained in the list of extensions.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl Decode for SearchRequest

fn decode_with_tag_and_constraints<_DECODER: Decoder>( decoder: &mut _DECODER, tag: Tag, constraints: Constraints, ) -> Result<Self, _DECODER::Error>

Decode this value implicitly tagged with tag from a given ASN.1 decoder with a set of constraints on what values of that type are allowed.

fn decode<D>(decoder: &mut D) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value from a given ASN.1 decoder.

fn decode_with_tag<D>( decoder: &mut D, tag: Tag, ) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value implicitly tagged with tag from a given ASN.1 decoder.

fn decode_with_constraints<D>( decoder: &mut D, constraints: Constraints, ) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value from a given ASN.1 decoder with a set of constraints on what values of that type are allowed.

impl Encode for SearchRequest

fn encode_with_tag_and_constraints<'encoder, _ENCODER: Encoder<'encoder>>( &self, encoder: &mut _ENCODER, tag: Tag, constraints: Constraints, identifier: Identifier, ) -> Result<(), _ENCODER::Error>

Encode this value with tag into the given crate::Encoder with the constraints the values this is allowed to encode into.

fn encode<'b, E>( &self, encoder: &mut E, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encodes self’s data into the given crate::Encoder.

fn encode_with_tag<'b, E>( &self, encoder: &mut E, tag: Tag, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with tag into the given crate::Encoder.

fn encode_with_identifier<'b, E>( &self, encoder: &mut E, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with identifier into the given crate::Encoder.

fn encode_with_tag_and_identifier<'b, E>( &self, encoder: &mut E, tag: Tag, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with tag and identifier into the given crate::Encoder.

fn encode_with_constraints<'b, E>( &self, encoder: &mut E, constraints: Constraints, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value into the given crate::Encoder with the constraints the values this is allowed to encode into.

fn encode_with_constraints_and_identifier<'b, E>( &self, encoder: &mut E, constraints: Constraints, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value into the given crate::Encoder with identifier and the constraints the values this is allowed to encode into.

impl Hash for SearchRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SearchRequest

fn eq(&self, other: &SearchRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SearchRequest

impl StructuralPartialEq for SearchRequest