Trait nom::lib::std::cmp::PartialEq1.0.0[−][src]

#[lang = "eq"]
pub trait PartialEq<Rhs = Self> where
    Rhs: ?Sized, {
    #[must_use]
    pub fn eq(&self, other: &Rhs) -> bool;

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

[−]

Trait for equality comparisons which are partial equivalence relations.

This trait allows for partial equality, for types that do not have a full equivalence relation. For example, in floating point numbers NaN != NaN, so floating point types implement PartialEq but not Eq.

Formally, the equality must be (for all a, b, c of type A, B, C):

Symmetric: if A: PartialEq and B: PartialEq<A>, then a == b implies b == a; and
Transitive: if A: PartialEq and B: PartialEq<C> and A: PartialEq<C>, then a == b and b == c implies a == c.

Note that the B: PartialEq<A> (symmetric) and A: PartialEq<C> (transitive) impls are not forced to exist, but these requirements apply whenever they do exist.

Derivable

This trait can be used with #[derive]. When derived on structs, two instances are equal if all fields are equal, and not equal if any fields are not equal. When derived on enums, each variant is equal to itself and not equal to the other variants.

How can I implement `PartialEq`?

PartialEq only requires the eq method to be implemented; ne is defined in terms of it by default. Any manual implementation of ne must respect the rule that eq is a strict inverse of ne; that is, !(a == b) if and only if a != b.

Implementations of PartialEq, PartialOrd, and Ord must agree with each other. It’s easy to accidentally make them disagree by deriving some of the traits and manually implementing others.

An example implementation for a domain in which two books are considered the same book if their ISBN matches, even if the formats differ:

enum BookFormat {
    Paperback,
    Hardback,
    Ebook,
}

struct Book {
    isbn: i32,
    format: BookFormat,
}

impl PartialEq for Book {
    fn eq(&self, other: &Self) -> bool {
        self.isbn == other.isbn
    }
}

let b1 = Book { isbn: 3, format: BookFormat::Paperback };
let b2 = Book { isbn: 3, format: BookFormat::Ebook };
let b3 = Book { isbn: 10, format: BookFormat::Paperback };

assert!(b1 == b2);
assert!(b1 != b3);

How can I compare two different types?

The type you can compare with is controlled by PartialEq’s type parameter. For example, let’s tweak our previous code a bit:

// The derive implements <BookFormat> == <BookFormat> comparisons
#[derive(PartialEq)]
enum BookFormat {
    Paperback,
    Hardback,
    Ebook,
}

struct Book {
    isbn: i32,
    format: BookFormat,
}

// Implement <Book> == <BookFormat> comparisons
impl PartialEq<BookFormat> for Book {
    fn eq(&self, other: &BookFormat) -> bool {
        self.format == *other
    }
}

// Implement <BookFormat> == <Book> comparisons
impl PartialEq<Book> for BookFormat {
    fn eq(&self, other: &Book) -> bool {
        *self == other.format
    }
}

let b1 = Book { isbn: 3, format: BookFormat::Paperback };

assert!(b1 == BookFormat::Paperback);
assert!(BookFormat::Ebook != b1);

By changing impl PartialEq for Book to impl PartialEq<BookFormat> for Book, we allow BookFormats to be compared with Books.

A comparison like the one above, which ignores some fields of the struct, can be dangerous. It can easily lead to an unintended violation of the requirements for a partial equivalence relation. For example, if we kept the above implementation of PartialEq<Book> for BookFormat and added an implementation of PartialEq<Book> for Book (either via a #[derive] or via the manual implementation from the first example) then the result would violate transitivity:

#[derive(PartialEq)]
enum BookFormat {
    Paperback,
    Hardback,
    Ebook,
}

#[derive(PartialEq)]
struct Book {
    isbn: i32,
    format: BookFormat,
}

impl PartialEq<BookFormat> for Book {
    fn eq(&self, other: &BookFormat) -> bool {
        self.format == *other
    }
}

impl PartialEq<Book> for BookFormat {
    fn eq(&self, other: &Book) -> bool {
        *self == other.format
    }
}

fn main() {
    let b1 = Book { isbn: 1, format: BookFormat::Paperback };
    let b2 = Book { isbn: 2, format: BookFormat::Paperback };

    assert!(b1 == BookFormat::Paperback);
    assert!(BookFormat::Paperback == b2);

    // The following should hold by transitivity but doesn't.
    assert!(b1 == b2); // <-- PANICS
}

Examples

let x: u32 = 0;
let y: u32 = 1;

assert_eq!(x == y, false);
assert_eq!(x.eq(&y), false);

Required methods

`#[must_use] pub fn eq(&self, other: &Rhs) -> bool`[src][−]

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

Provided methods

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

This method tests for !=.

Trait nom::lib::std::cmp::PartialEq⎘1.0.0[−][src]

Derivable

How can I implement PartialEq?

How can I compare two different types?

Examples

Required methods

#[must_use]pub fn eq(&self, other: &Rhs) -> bool[src][−]

Provided methods

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

Implementations on Foreign Types

impl<Dyn> PartialEq<DynMetadata<Dyn>> for DynMetadata<Dyn> where Dyn: ?Sized, [src][−]

pub fn eq(&self, other: &DynMetadata<Dyn>) -> bool[src]

impl PartialEq<Layout> for Layout[src][−]

pub fn eq(&self, other: &Layout) -> bool[src]

pub fn ne(&self, other: &Layout) -> bool[src]

impl PartialEq<NonZeroU128> for NonZeroU128[src][−]

pub fn eq(&self, other: &NonZeroU128) -> bool[src]

pub fn ne(&self, other: &NonZeroU128) -> bool[src]

impl PartialEq<ParseFloatError> for ParseFloatError[src][−]

pub fn eq(&self, other: &ParseFloatError) -> bool[src]

pub fn ne(&self, other: &ParseFloatError) -> bool[src]

impl PartialEq<PhantomPinned> for PhantomPinned[src][−]

pub fn eq(&self, other: &PhantomPinned) -> bool[src]

impl PartialEq<NonZeroIsize> for NonZeroIsize[src][−]

pub fn eq(&self, other: &NonZeroIsize) -> bool[src]

pub fn ne(&self, other: &NonZeroIsize) -> bool[src]

impl PartialEq<RawWakerVTable> for RawWakerVTable[src][−]

pub fn eq(&self, other: &RawWakerVTable) -> bool[src]

pub fn ne(&self, other: &RawWakerVTable) -> bool[src]

impl PartialEq<NonZeroI16> for NonZeroI16[src][−]

pub fn eq(&self, other: &NonZeroI16) -> bool[src]

pub fn ne(&self, other: &NonZeroI16) -> bool[src]

impl PartialEq<FpCategory> for FpCategory[src][−]

pub fn eq(&self, other: &FpCategory) -> bool[src]

impl PartialEq<AllocError> for AllocError[src][−]

pub fn eq(&self, other: &AllocError) -> bool[src]

impl<T> PartialEq<NonNull<T>> for NonNull<T> where T: ?Sized, [src][−]

pub fn eq(&self, other: &NonNull<T>) -> bool[src]

impl PartialEq<DecodeUtf16Error> for DecodeUtf16Error[src][−]

pub fn eq(&self, other: &DecodeUtf16Error) -> bool[src]

pub fn ne(&self, other: &DecodeUtf16Error) -> bool[src]

impl<H> PartialEq<BuildHasherDefault<H>> for BuildHasherDefault<H>[src][−]

pub fn eq(&self, _other: &BuildHasherDefault<H>) -> bool[src]

impl<T> PartialEq<OnceCell<T>> for OnceCell<T> where T: PartialEq<T>, [src][−]

pub fn eq(&self, other: &OnceCell<T>) -> bool[src]

impl<P, Q> PartialEq<Pin<Q>> for Pin<P> where P: Deref, Q: Deref, <P as Deref>::Target: PartialEq<<Q as Deref>::Target>, [src][−]

pub fn eq(&self, other: &Pin<Q>) -> bool[src]

pub fn ne(&self, other: &Pin<Q>) -> bool[src]

impl PartialEq<NonZeroI128> for NonZeroI128[src][−]

pub fn eq(&self, other: &NonZeroI128) -> bool[src]

pub fn ne(&self, other: &NonZeroI128) -> bool[src]

impl PartialEq<NonZeroI8> for NonZeroI8[src][−]

pub fn eq(&self, other: &NonZeroI8) -> bool[src]

pub fn ne(&self, other: &NonZeroI8) -> bool[src]

impl<T> PartialEq<Wrapping<T>> for Wrapping<T> where T: PartialEq<T>, [src][−]

pub fn eq(&self, other: &Wrapping<T>) -> bool[src]

pub fn ne(&self, other: &Wrapping<T>) -> bool[src]

impl<T> PartialEq<PhantomData<T>> for PhantomData<T> where T: ?Sized, [src][−]

pub fn eq(&self, _other: &PhantomData<T>) -> bool[src]

impl PartialEq<NonZeroU64> for NonZeroU64[src][−]

pub fn eq(&self, other: &NonZeroU64) -> bool[src]

pub fn ne(&self, other: &NonZeroU64) -> bool[src]

impl PartialEq<NonZeroI32> for NonZeroI32[src][−]

pub fn eq(&self, other: &NonZeroI32) -> bool[src]

pub fn ne(&self, other: &NonZeroI32) -> bool[src]

impl<T> PartialEq<Cell<T>> for Cell<T> where T: PartialEq<T> + Copy, [src][−]

pub fn eq(&self, other: &Cell<T>) -> bool[src]

impl<T> PartialEq<Poll<T>> for Poll<T> where T: PartialEq<T>, [src][−]

pub fn eq(&self, other: &Poll<T>) -> bool[src]

pub fn ne(&self, other: &Poll<T>) -> bool[src]

impl PartialEq<NonZeroU32> for NonZeroU32[src][−]

pub fn eq(&self, other: &NonZeroU32) -> bool[src]

pub fn ne(&self, other: &NonZeroU32) -> bool[src]

impl PartialEq<RawWaker> for RawWaker[src][−]

pub fn eq(&self, other: &RawWaker) -> bool[src]

pub fn ne(&self, other: &RawWaker) -> bool[src]

impl PartialEq<TypeId> for TypeId[src][−]

pub fn eq(&self, other: &TypeId) -> bool[src]

pub fn ne(&self, other: &TypeId) -> bool[src]

impl PartialEq<TryFromIntError> for TryFromIntError[src][−]

Trait nom::lib::std::cmp::PartialEq1.0.0[−][src]

How can I implement `PartialEq`?

`#[must_use] pub fn eq(&self, other: &Rhs) -> bool`[src][−]

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

`impl<Dyn> PartialEq<DynMetadata<Dyn>> for DynMetadata<Dyn> where Dyn: ?Sized,` [src][−]

`pub fn eq(&self, other: &DynMetadata<Dyn>) -> bool`[src]

`impl PartialEq<Layout> for Layout`[src][−]

`pub fn eq(&self, other: &Layout) -> bool`[src]

`pub fn ne(&self, other: &Layout) -> bool`[src]

`impl PartialEq<NonZeroU128> for NonZeroU128`[src][−]

`pub fn eq(&self, other: &NonZeroU128) -> bool`[src]

`pub fn ne(&self, other: &NonZeroU128) -> bool`[src]

`impl PartialEq<ParseFloatError> for ParseFloatError`[src][−]

`pub fn eq(&self, other: &ParseFloatError) -> bool`[src]

`pub fn ne(&self, other: &ParseFloatError) -> bool`[src]

`impl PartialEq<PhantomPinned> for PhantomPinned`[src][−]

`pub fn eq(&self, other: &PhantomPinned) -> bool`[src]

`impl PartialEq<NonZeroIsize> for NonZeroIsize`[src][−]

`pub fn eq(&self, other: &NonZeroIsize) -> bool`[src]

`pub fn ne(&self, other: &NonZeroIsize) -> bool`[src]

`impl PartialEq<RawWakerVTable> for RawWakerVTable`[src][−]

`pub fn eq(&self, other: &RawWakerVTable) -> bool`[src]

`pub fn ne(&self, other: &RawWakerVTable) -> bool`[src]

`impl PartialEq<NonZeroI16> for NonZeroI16`[src][−]

`pub fn eq(&self, other: &NonZeroI16) -> bool`[src]

`pub fn ne(&self, other: &NonZeroI16) -> bool`[src]

`impl PartialEq<FpCategory> for FpCategory`[src][−]

`pub fn eq(&self, other: &FpCategory) -> bool`[src]

`impl PartialEq<AllocError> for AllocError`[src][−]

`pub fn eq(&self, other: &AllocError) -> bool`[src]

`impl<T> PartialEq<NonNull<T>> for NonNull<T> where T: ?Sized,` [src][−]

`pub fn eq(&self, other: &NonNull<T>) -> bool`[src]

`impl PartialEq<DecodeUtf16Error> for DecodeUtf16Error`[src][−]

`pub fn eq(&self, other: &DecodeUtf16Error) -> bool`[src]

`pub fn ne(&self, other: &DecodeUtf16Error) -> bool`[src]

`impl<H> PartialEq<BuildHasherDefault<H>> for BuildHasherDefault<H>`[src][−]

`pub fn eq(&self, _other: &BuildHasherDefault<H>) -> bool`[src]

`impl<T> PartialEq<OnceCell<T>> for OnceCell<T> where T: PartialEq<T>,` [src][−]

`pub fn eq(&self, other: &OnceCell<T>) -> bool`[src]

`impl<P, Q> PartialEq<Pin<Q>> for Pin<P> where P: Deref, Q: Deref, <P as Deref>::Target: PartialEq<<Q as Deref>::Target>,` [src][−]

`pub fn eq(&self, other: &Pin<Q>) -> bool`[src]

`pub fn ne(&self, other: &Pin<Q>) -> bool`[src]

`impl PartialEq<NonZeroI128> for NonZeroI128`[src][−]

`pub fn eq(&self, other: &NonZeroI128) -> bool`[src]

`pub fn ne(&self, other: &NonZeroI128) -> bool`[src]

`impl PartialEq<NonZeroI8> for NonZeroI8`[src][−]

`pub fn eq(&self, other: &NonZeroI8) -> bool`[src]

`pub fn ne(&self, other: &NonZeroI8) -> bool`[src]

`impl<T> PartialEq<Wrapping<T>> for Wrapping<T> where T: PartialEq<T>,` [src][−]

`pub fn eq(&self, other: &Wrapping<T>) -> bool`[src]

`pub fn ne(&self, other: &Wrapping<T>) -> bool`[src]

`impl<T> PartialEq<PhantomData<T>> for PhantomData<T> where T: ?Sized,` [src][−]

`pub fn eq(&self, _other: &PhantomData<T>) -> bool`[src]

`impl PartialEq<NonZeroU64> for NonZeroU64`[src][−]

`pub fn eq(&self, other: &NonZeroU64) -> bool`[src]

`pub fn ne(&self, other: &NonZeroU64) -> bool`[src]

`impl PartialEq<NonZeroI32> for NonZeroI32`[src][−]

`pub fn eq(&self, other: &NonZeroI32) -> bool`[src]

`pub fn ne(&self, other: &NonZeroI32) -> bool`[src]

`impl<T> PartialEq<Cell<T>> for Cell<T> where T: PartialEq<T> + Copy,` [src][−]

`pub fn eq(&self, other: &Cell<T>) -> bool`[src]

`impl<T> PartialEq<Poll<T>> for Poll<T> where T: PartialEq<T>,` [src][−]

`pub fn eq(&self, other: &Poll<T>) -> bool`[src]

`pub fn ne(&self, other: &Poll<T>) -> bool`[src]

`impl PartialEq<NonZeroU32> for NonZeroU32`[src][−]

`pub fn eq(&self, other: &NonZeroU32) -> bool`[src]

`pub fn ne(&self, other: &NonZeroU32) -> bool`[src]

`impl PartialEq<RawWaker> for RawWaker`[src][−]

`pub fn eq(&self, other: &RawWaker) -> bool`[src]

`pub fn ne(&self, other: &RawWaker) -> bool`[src]

`impl PartialEq<TypeId> for TypeId`[src][−]

`pub fn eq(&self, other: &TypeId) -> bool`[src]

`pub fn ne(&self, other: &TypeId) -> bool`[src]

`impl PartialEq<TryFromIntError> for TryFromIntError`[src][−]

`pub fn eq(&self, other: &TryFromIntError) -> bool`[src]

`pub fn ne(&self, other: &TryFromIntError) -> bool`[src]

`impl PartialEq<IntErrorKind> for IntErrorKind`[src][−]

`pub fn eq(&self, other: &IntErrorKind) -> bool`[src]

`impl PartialEq<NonZeroI64> for NonZeroI64`[src][−]

`pub fn eq(&self, other: &NonZeroI64) -> bool`[src]