Trait ockam_core::lib::marker::StructuralEq

pub trait StructuralEq { }

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

Required trait for constants used in pattern matches.

Any type that derives Eq automatically implements this trait, regardless of whether its type parameters implement Eq.

This is a hack to work around a limitation in our type system.

Background

We want to require that types of consts used in pattern matches have the attribute #[derive(PartialEq, Eq)].

In a more ideal world, we could check that requirement by just checking that the given type implements both the StructuralPartialEq trait and the Eq trait. However, you can have ADTs that do derive(PartialEq, Eq), and be a case that we want the compiler to accept, and yet the constant’s type fails to implement Eq.

Namely, a case like this:

#[derive(PartialEq, Eq)]
struct Wrap<X>(X);

fn higher_order(_: &()) { }

const CFN: Wrap<fn(&())> = Wrap(higher_order);

fn main() {
    match CFN {
        CFN => {}
        _ => {}
    }
}

(The problem in the above code is that Wrap<fn(&())> does not implement PartialEq, nor Eq, because for<'a> fn(&'a _) does not implement those traits.)

Therefore, we cannot rely on naive check for StructuralPartialEq and mere Eq.

As a hack to work around this, we use two separate traits injected by each of the two derives (#[derive(PartialEq)] and #[derive(Eq)]) and check that both of them are present as part of structural-match checking.

Implementations on Foreign Types

impl<'a> StructuralEq for Location<'a>

impl StructuralEq for DecodeUtf16Error

impl<Idx> StructuralEq for RangeToInclusive<Idx>

impl<Idx> StructuralEq for RangeFrom<Idx>

impl StructuralEq for TypeId

impl StructuralEq for RangeFull

impl<'a> StructuralEq for Utf8LossyChunk<'a>

impl<Idx> StructuralEq for RangeInclusive<Idx>

impl StructuralEq for Ordering

impl StructuralEq for CharTryFromError

impl<T> StructuralEq for Bound<T>

impl StructuralEq for ParseCharError

impl<T> StructuralEq for Poll<T>

impl StructuralEq for CpuidResult

impl<Idx> StructuralEq for RangeTo<Idx>

impl<Y, R> StructuralEq for GeneratorState<Y, R>

impl StructuralEq for LayoutError

impl StructuralEq for Layout

impl StructuralEq for Duration

impl StructuralEq for AllocError

impl StructuralEq for RecvTimeoutError

impl StructuralEq for ThreadId

impl<'a> StructuralEq for Component<'a>

impl<'a> StructuralEq for Prefix<'a>

impl StructuralEq for Permissions

impl StructuralEq for CString

impl StructuralEq for FileType

impl StructuralEq for Instant

impl StructuralEq for VarError

impl<T> StructuralEq for SendError<T>

impl<'a> StructuralEq for PrefixComponent<'a>

impl StructuralEq for ExitStatus

impl StructuralEq for NulError

impl StructuralEq for RecvError

impl<T> StructuralEq for TrySendError<T>

impl StructuralEq for TryRecvError

impl StructuralEq for StripPrefixError

impl StructuralEq for ExitStatusError

impl StructuralEq for AccessError

impl StructuralEq for SeekFrom

impl<T> StructuralEq for Cursor<T>

impl StructuralEq for WaitTimeoutResult

impl StructuralEq for SystemTime

impl StructuralEq for FromBytesWithNulError

impl StructuralEq for BacktraceStatus

impl StructuralEq for Output

impl StructuralEq for FromVecWithNulError

impl StructuralEq for IntoStringError

impl StructuralEq for ErrorKind

impl StructuralEq for FromUtf8Error

impl StructuralEq for TryReserveError

impl StructuralEq for TryReserveError

impl StructuralEq for Error

impl StructuralEq for StdRng

impl StructuralEq for StepRng

impl StructuralEq for WeightedError

impl StructuralEq for BernoulliError

impl StructuralEq for ChaCha20Core

impl StructuralEq for ChaCha8Core

impl StructuralEq for ChaCha12Core

impl StructuralEq for Uint

impl StructuralEq for Int

Implementors

impl StructuralEq for RouterMessage

impl StructuralEq for IpAddr

impl StructuralEq for Ipv6MulticastScope

impl StructuralEq for Shutdown

impl StructuralEq for SocketAddr

impl StructuralEq for FpCategory

impl StructuralEq for IntErrorKind

impl StructuralEq for SearchStep

impl StructuralEq for Address

impl StructuralEq for AddressSet

impl StructuralEq for Any

impl StructuralEq for ProtocolId

impl StructuralEq for Route

impl StructuralEq for TransportMessage

impl StructuralEq for ockam_core::lib::fmt::Error

impl StructuralEq for AddrParseError

impl StructuralEq for NonZeroI8

impl StructuralEq for NonZeroI16

impl StructuralEq for NonZeroI32

impl StructuralEq for NonZeroI64

impl StructuralEq for NonZeroI128

impl StructuralEq for NonZeroIsize

impl StructuralEq for NonZeroU8

impl StructuralEq for NonZeroU16

impl StructuralEq for NonZeroU32

impl StructuralEq for NonZeroU64

impl StructuralEq for NonZeroU128

impl StructuralEq for NonZeroUsize

impl StructuralEq for ParseFloatError

impl StructuralEq for ParseIntError

impl StructuralEq for TryFromIntError

impl StructuralEq for ParseBoolError

impl StructuralEq for Utf8Error

impl StructuralEq for String

impl StructuralEq for PhantomPinned

impl<Idx> StructuralEq for Range<Idx>

impl<T> StructuralEq for Option<T>

impl<T> StructuralEq for Reverse<T>

impl<T> StructuralEq for ManuallyDrop<T> where
    T: ?Sized, 

impl<T> StructuralEq for Wrapping<T>

impl<T> StructuralEq for BTreeSet<T>

impl<T> StructuralEq for PhantomData<T> where
    T: ?Sized, 

impl<T, E> StructuralEq for Result<T, E>