Struct kanidmd_lib::filter::Filter

source ·
pub struct Filter<STATE> { /* private fields */ }
Expand description

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 secuerly. checked

Implementations§

source§

impl Filter<FilterValidResolved>

source

pub fn to_inner(&self) -> &FilterResolved

source§

impl Filter<FilterValid>

source

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

source

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

source

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

source

pub fn into_ignore_hidden(self) -> Self

source

pub fn into_recycled(self) -> Self

source§

impl Filter<FilterInvalid>

source

pub fn new(inner: FC<'_>) -> Self

source

pub fn new_ignore_hidden(inner: FC<'_>) -> Self

source

pub fn new_recycled(inner: FC<'_>) -> Self

source

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

source

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

source

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

source

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

source

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

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<STATE: Debug> Debug for Filter<STATE>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<STATE: Ord> Ord for Filter<STATE>

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

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

source§

fn eq(&self, other: &Filter<STATE>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<STATE: PartialOrd> PartialOrd<Filter<STATE>> for Filter<STATE>

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

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

source§

impl<STATE> StructuralEq for Filter<STATE>

source§

impl<STATE> StructuralPartialEq for Filter<STATE>

Auto Trait Implementations§

§

impl<STATE> RefUnwindSafe for Filter<STATE>where STATE: RefUnwindSafe,

§

impl<STATE> Send for Filter<STATE>where STATE: Send,

§

impl<STATE> Sync for Filter<STATE>where STATE: Sync,

§

impl<STATE> Unpin for Filter<STATE>where STATE: Unpin,

§

impl<STATE> UnwindSafe for Filter<STATE>where STATE: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

§

impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CallHasher for Twhere T: Hash + ?Sized,

§

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where H: Hash + ?Sized, B: BuildHasher,

source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more