Struct Filter

pub struct Filter<STATE> { /* private fields */ }

A Filter is a logical set of assertions about the state of an Entry and it’s avas. Filters are built from a set of possible assertions.

• Presence. An ava of that attribute’s name exists, with any value on the Entry.
• Equality. An ava of the attribute exists and contains this matching value.
• Substring. An ava of the attribute exists and has a substring containing the requested value.
• Or. Contains multiple filters and asserts at least one is true.
• And. Contains multiple filters and asserts all of them are true.
• AndNot. This is different to a “logical not” operation. This asserts that a condition is not true in the current candidate set. A search of AndNot alone will yield not results, but an AndNot in an And query will assert that a condition can not hold.

Filters for security reasons are validated by the schema to assert all requested attributes are valid and exist in the schema so that they can have their indexes correctly used. This avoids a denial of service attack that may lead to full-table scans.

This Filter validation state is in the STATE attribute and will be either FilterInvalid or FilterValid. The Filter must be checked by the schema to move to FilterValid. This helps to prevent errors at compile time to assert Filters are securely checked

Implementations

impl Filter<FilterValidResolved>

pub fn to_inner(&self) -> &FilterResolved

impl Filter<FilterValid>

pub fn invalidate(self) -> Filter<FilterInvalid>

pub fn resolve( &self, ev: &Identity, idxmeta: Option<&IdxMeta>, rsv_cache: Option<&mut ResolveFilterCacheReadTxn<'_>>, ) -> Result<Filter<FilterValidResolved>, OperationError>

pub fn get_attr_set(&self) -> BTreeSet<Attribute>

pub fn into_ignore_hidden(self) -> Self

pub fn into_recycled(self) -> Self

impl Filter<FilterInvalid>

pub fn new(inner: FC) -> Self

pub fn new_ignore_hidden(inner: FC) -> Self

pub fn new_recycled(inner: FC) -> Self

pub fn join_parts_and(a: Self, b: Self) -> Self

pub fn validate( &self, schema: &dyn SchemaTransaction, ) -> Result<Filter<FilterValid>, SchemaError>

pub fn from_ro( ev: &Identity, f: &ProtoFilter, qs: &mut QueryServerReadTransaction<'_>, ) -> Result<Self, OperationError>

pub fn from_rw( ev: &Identity, f: &ProtoFilter, qs: &mut QueryServerWriteTransaction<'_>, ) -> Result<Self, OperationError>

pub fn from_ldap_ro( ev: &Identity, f: &LdapFilter, qs: &mut QueryServerReadTransaction<'_>, ) -> Result<Self, OperationError>

pub fn from_scim_ro( ev: &Identity, f: &ScimFilter, qs: &mut QueryServerReadTransaction<'_>, ) -> Result<Self, OperationError>

Trait Implementations

impl<STATE: Clone> Clone for Filter<STATE>

fn clone(&self) -> Filter<STATE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Filter<FilterInvalid>

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

Formats the value using the given formatter.

impl Debug for Filter<FilterValid>

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

Formats the value using the given formatter.

impl Debug for Filter<FilterValidResolved>

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

Formats the value using the given formatter.

impl FromStr for Filter<FilterInvalid>

type Err = OperationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<STATE: Hash> Hash for Filter<STATE>

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<STATE: Ord> Ord for Filter<STATE>

fn cmp(&self, other: &Filter<STATE>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<STATE: PartialEq> PartialEq for Filter<STATE>

fn eq(&self, other: &Filter<STATE>) -> 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<STATE: PartialOrd> PartialOrd for Filter<STATE>

fn partial_cmp(&self, other: &Filter<STATE>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<STATE: Eq> Eq for Filter<STATE>

impl<STATE> StructuralPartialEq for Filter<STATE>