Struct abi_stable::sabi_types::CmpIgnored

#[repr(transparent)]
pub struct CmpIgnored<T> {
    pub value: T,
}

Wrapper type used to ignore its contents in comparisons.

Use this if you want to derive trait while ignoring the contents of fields in the PartialEq/Eq/PartialOrd/Ord/Hash traits.

It also replaces the hash of T with the hash of ().

Example

This example defines a struct with a CmpIgnored field.

use abi_stable::sabi_types::CmpIgnored;

use std::collections::HashSet;

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct User {
    name: String,
    surname: String,
    alt_name: CmpIgnored<String>,
}

let a = User {
    name: "J__n".to_string(),
    surname: "E____t".to_string(),
    alt_name: "Z______l P______d".to_string().into(),
};

let b = User {
    name: "J__n".to_string(),
    surname: "E____t".to_string(),
    alt_name: "H___ of B_____".to_string().into(),
};

assert_eq!(a, b);

let mut map = HashSet::new();

map.replace(a.clone());
assert_eq!(
    map.replace(b.clone()).unwrap().alt_name.as_str(),
    "Z______l P______d"
);

assert_eq!(map.len(), 1);
assert_eq!(map.get(&a).unwrap().alt_name.as_str(), "H___ of B_____");

Fields

value: T

Implementations

impl<T> CmpIgnored<T>

pub const fn new(value: T) -> Self

Constructs a CmpIgnored.

Example

use abi_stable::sabi_types::CmpIgnored;

let val = CmpIgnored::new(100);

Trait Implementations

impl<T: Clone> Clone for CmpIgnored<T>

fn clone(&self) -> CmpIgnored<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CmpIgnored<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T: Default> Default for CmpIgnored<T>

fn default() -> CmpIgnored<T>

Returns the “default value” for a type.

impl<T> Deref for CmpIgnored<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for CmpIgnored<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for CmpIgnored<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> From<T> for CmpIgnored<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> GetStaticEquivalent_ for CmpIgnored<T>

where T: __StableAbi,

type StaticEquivalent = _static_CmpIgnored<<T as GetStaticEquivalent_>::StaticEquivalent>

The 'static equivalent of Self

impl<T> Hash for CmpIgnored<T>

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

where H: Hasher,

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<T> Ord for CmpIgnored<T>

fn cmp(&self, _other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for CmpIgnored<T>

fn eq(&self, _other: &Self) -> 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<T> PartialOrd for CmpIgnored<T>

fn partial_cmp(&self, _other: &Self) -> 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<T> StableAbi for CmpIgnored<T>

where T: __StableAbi,

type IsNonZeroType = <T as StableAbi>::IsNonZeroType

Whether this type has a single invalid bit-pattern.

const LAYOUT: &'static TypeLayout = _

The layout of the type provided by implementors.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl<T: Copy> Copy for CmpIgnored<T>

impl<T> Eq for CmpIgnored<T>