Struct cmp_wrap::permissive::CmpByKey

pub struct CmpByKey<'kf, KF, T> { /* fields omitted */ }

The main structure of this crate. Lets you define a "key function" over any structure, which will change the way the value is being compared. Very useful when you need to enter your data to different data structures (such as max heaps, sorted trees and so on), with different comparision criteria.

Methods

impl<'kf, KF, T> CmpByKey<'kf, KF, T>

pub fn new<'rkf>(value: T, key_func: &'rkf KF) -> Self where
    'rkf: 'kf, 

Let you wrap a value with a key function which defines the way to compare it to other values.

Example

use cmp_wrap::permissive::CmpByKey;
let x = CmpByKey::new(32, &|x: &i32| -> i32 { -*x });

pub fn remove_wrapper(self) -> T

Lets you get the original value which the wrapper wrappes, destroys the wrapper.

Example

use cmp_wrap::permissive::CmpByKey;
let v: i32 = 32;

fn is_type_i32(x: i32) {};

let x = CmpByKey::new(v, &|x: &i32| -> i32 { -*x });
let v_again = x.remove_wrapper();

is_type_i32(v_again);

Trait Implementations

impl<'_, T: Debug, KF> Debug for CmpByKey<'_, KF, T>

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

Formats the value using the given formatter.

impl<'_, T, K: Eq, KF> Eq for CmpByKey<'_, KF, T> where
    KF: Fn(&T) -> K, 

impl<'_, T, K: Ord, KF> Ord for CmpByKey<'_, KF, T> where
    KF: Fn(&T) -> K, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_, '_, T, K, KF, OT, OKF, OK> PartialEq<CmpByKey<'_, OKF, OT>> for CmpByKey<'_, KF, T> where
    K: PartialEq<OK>,
    KF: Fn(&T) -> K,
    OKF: Fn(&OT) -> OK, 

fn eq(&self, other: &CmpByKey<OKF, OT>) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, '_, T, K, KF, OT, OKF, OK> PartialOrd<CmpByKey<'_, OKF, OT>> for CmpByKey<'_, KF, T> where
    K: PartialOrd<OK>,
    KF: Fn(&T) -> K,
    OKF: Fn(&OT) -> OK, 

fn partial_cmp(&self, other: &CmpByKey<OKF, OT>) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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