core::cmp

Trait Eq

1.6.0 · Source

pub trait Eq: PartialEq<Self> {
    // Provided method
    #[doc(hidden)] fn assert_receiver_is_total_eq(&self) { ... }
}

Expand description

Trait for comparisons corresponding to equivalence relations.

The primary difference to PartialEq is the additional requirement for reflexivity. A type that implements PartialEq guarantees that for all a, b and c:

symmetric: a == b implies b == a and a != b implies !(a == b)
transitive: a == b and b == c implies a == c

Eq, which builds on top of PartialEq also implies:

reflexive: a == a

This property cannot be checked by the compiler, and therefore Eq is a trait without methods.

Violating this property is a logic error. The behavior resulting from a logic error is not specified, but users of the trait must ensure that such logic errors do not result in undefined behavior. This means that unsafe code must not rely on the correctness of these methods.

Floating point types such as f32 and f64 implement only PartialEq but not Eq because NaN != NaN.

§Derivable

This trait can be used with #[derive]. When derived, because Eq has no extra methods, it is only informing the compiler that this is an equivalence relation rather than a partial equivalence relation. Note that the derive strategy requires all fields are Eq, which isn’t always desired.

§How can I implement `Eq`?

If you cannot use the derive strategy, specify that your type implements Eq, which has no extra methods:

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
    }
}

impl Eq for Book {}

Provided Methods§

1.0.0 · Source

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait EqCopy item path

§Derivable

§How can I implement Eq?

Provided Methods§

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

Dyn Compatibility§

Implementors§

impl Eq for AsciiChar

impl Eq for CharErrorKind

impl Eq for Infallible

impl Eq for FromBytesWithNulError

impl Eq for core::fmt::Alignment

impl Eq for DebugAsHex

impl Eq for core::fmt::Sign

impl Eq for IpAddr

impl Eq for Ipv6MulticastScope

impl Eq for AddrKind

impl Eq for SocketAddr

impl Eq for FloatErrorKind

impl Eq for FpCategory

impl Eq for IntErrorKind

impl Eq for FullDecoded

impl Eq for core::num::flt2dec::Sign

impl Eq for AlignmentEnum

impl Eq for GetDisjointMutError

impl Eq for SearchStep

impl Eq for core::sync::atomic::Ordering

impl Eq for TryFromFloatSecsErrorKind

impl Eq for core::cmp::Ordering

impl Eq for bool

impl Eq for char

impl Eq for i8

impl Eq for i16

impl Eq for i32

impl Eq for i64

impl Eq for i128

impl Eq for isize

impl Eq for !

impl Eq for str

impl Eq for u8

impl Eq for u16

impl Eq for u32

impl Eq for u64

impl Eq for u128

impl Eq for ()

impl Eq for usize

impl Eq for Layout

impl Eq for LayoutError

impl Eq for AllocError

impl Eq for TypeId

impl Eq for ByteStr

impl Eq for CharTryFromError

impl Eq for ParseCharError

impl Eq for DecodeUtf16Error

impl Eq for TryFromCharError

impl Eq for CpuidResult

impl Eq for CStr

impl Eq for FromBytesUntilNulError

impl Eq for Error

impl Eq for FormattingOptions

impl Eq for PhantomPinned

impl Eq for Assume

impl Eq for Ipv4Addr

impl Eq for Ipv6Addr

impl Eq for AddrParseError

impl Eq for SocketAddrV4

impl Eq for SocketAddrV6

impl Eq for Big32x40

impl Eq for Big8x3

impl Eq for BiasedFp

impl Eq for Decimal

impl Eq for ParseFloatError

impl Eq for ParseIntError

impl Eq for TryFromIntError

impl Eq for Decoded

impl Eq for I32NotAllOnes

impl Eq for I64NotAllOnes

impl Eq for Nanoseconds

impl Eq for NonZeroI8Inner

impl Eq for NonZeroI16Inner

Trait Eq

§How can I implement `Eq`?

impl<A> Eq for &A
where A: Eq + ?Sized,

impl<A> Eq for &mut A
where A: Eq + ?Sized,

impl<A: Eq, Z: Eq, Y: Eq, X: Eq, W: Eq, V: Eq, U: Eq, T> Eq for (A, Z, Y, X, W, V, U, T)
where T: ?Sized + Eq,

impl<B: Eq, A: Eq, Z: Eq, Y: Eq, X: Eq, W: Eq, V: Eq, U: Eq, T> Eq for (B, A, Z, Y, X, W, V, U, T)
where T: ?Sized + Eq,

impl<C: Eq, B: Eq, A: Eq, Z: Eq, Y: Eq, X: Eq, W: Eq, V: Eq, U: Eq, T> Eq for (C, B, A, Z, Y, X, W, V, U, T)
where T: ?Sized + Eq,

impl<D: Eq, C: Eq, B: Eq, A: Eq, Z: Eq, Y: Eq, X: Eq, W: Eq, V: Eq, U: Eq, T> Eq for (D, C, B, A, Z, Y, X, W, V, U, T)
where T: ?Sized + Eq,

impl<E: Eq, D: Eq, C: Eq, B: Eq, A: Eq, Z: Eq, Y: Eq, X: Eq, W: Eq, V: Eq, U: Eq, T> Eq for (E, D, C, B, A, Z, Y, X, W, V, U, T)
where T: ?Sized + Eq,

impl<T> Eq for (T₁, T₂, …, Tₙ)
where T: ?Sized + Eq,

impl<T> Eq for PhantomContravariant<T>
where T: ?Sized,

impl<T> Eq for PhantomCovariant<T>
where T: ?Sized,

impl<T> Eq for PhantomInvariant<T>
where T: ?Sized,

impl<T> Eq for NonZero<T>
where T: ZeroablePrimitive + Eq,

impl<T, const N: usize> Eq for Mask<T, N>
where T: MaskElement + Eq, LaneCount<N>: SupportedLaneCount,

impl<T, const N: usize> Eq for Simd<T, N>
where LaneCount<N>: SupportedLaneCount, T: SimdElement + Eq,