derive-where 1.6.1

Deriving with custom trait bounds
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! [`PartialEq`](trait@std::cmp::PartialEq) implementation.

use std::ops::Deref;

use proc_macro2::TokenStream;
use quote::quote;

use super::common_ord::build_incomparable_pattern;
use crate::{
	util, Data, DeriveTrait, DeriveWhere, Item, SimpleType, SplitGenerics, Trait, TraitImpl,
};

/// [`TraitImpl`] for [`PartialEq`](trait@std::cmp::PartialEq).
pub struct PartialEq;

impl TraitImpl for PartialEq {
	fn as_str() -> &'static str {
		"PartialEq"
	}

	fn default_derive_trait() -> DeriveTrait {
		DeriveTrait::PartialEq
	}

	fn path(&self) -> syn::Path {
		util::path_from_strs(&["core", "cmp", "PartialEq"])
	}

	fn build_signature(
		&self,
		_derive_where: &DeriveWhere,
		item: &Item,
		_generics: &SplitGenerics<'_>,
		body: &TokenStream,
	) -> TokenStream {
		let body = {
			match item {
				// If the whole item is incomparable return false
				item if item.is_incomparable() => {
					quote! { false }
				}
				// If there is more than one variant and not all variants are empty, check for
				// discriminant and match on variant data.
				Item::Enum { variants, .. } if variants.len() > 1 && !item.is_empty(**self) => {
					// Return `true` in the rest pattern if there are any empty variants
					// that are not incomparable.
					let rest = if variants
						.iter()
						.any(|variant| variant.is_empty(**self) && !variant.is_incomparable())
					{
						quote! { true }
					} else {
						#[cfg(not(feature = "safe"))]
						// This follows the standard implementation.
						quote! { unsafe { ::core::hint::unreachable_unchecked() } }
						#[cfg(feature = "safe")]
						quote! { ::core::unreachable!("comparing variants yielded unexpected results") }
					};

					// Return `false` for all incomparable variants
					let incomparable = build_incomparable_pattern(variants).into_iter();

					quote! {
						if ::core::mem::discriminant(self) == ::core::mem::discriminant(__other) {
							match (self, __other) {
								#body
								#((#incomparable, ..) => false,)*
								_ => #rest,
							}
						} else {
							false
						}
					}
				}
				// If there is more than one variant and all are empty, check for
				// discriminant and simply return `true` if it is not incomparable.
				Item::Enum { variants, .. } if variants.len() > 1 && item.is_empty(**self) => {
					let incomparable = build_incomparable_pattern(variants).into_iter();
					quote! {
						if ::core::mem::discriminant(self) == ::core::mem::discriminant(__other) {
							#(if ::core::matches!(self, #incomparable) {
								return false;
							})*
							true
						} else {
							false
						}
					}
				}
				// If there is only one variant and it's empty or if the struct is empty, simply
				// return `true`.
				item if item.is_empty(**self) => {
					quote! { true }
				}
				_ => {
					quote! {
						match (self, __other) {
							#body
						}
					}
				}
			}
		};

		quote! {
			#[inline]
			fn eq(&self, __other: &Self) -> ::core::primitive::bool {
				#body
			}
		}
	}

	fn build_body(&self, _derive_where: &DeriveWhere, data: &Data) -> TokenStream {
		if data.is_empty(**self) || data.is_incomparable() {
			TokenStream::new()
		} else {
			match data.simple_type() {
				SimpleType::Struct(fields) | SimpleType::Tuple(fields) => {
					let self_pattern = &fields.self_pattern;
					let other_pattern = &fields.other_pattern;
					let trait_path = self.path();
					let self_ident = data.iter_self_ident(**self);
					let other_ident = data.iter_other_ident(**self);

					quote! {
						(#self_pattern, #other_pattern) =>
							true #(&& #trait_path::eq(#self_ident, #other_ident))*,
					}
				}
				SimpleType::Unit(_) => TokenStream::new(),
				SimpleType::Union => unreachable!("unexpected trait for union"),
			}
		}
	}
}

impl Deref for PartialEq {
	type Target = Trait;

	fn deref(&self) -> &Self::Target {
		&Trait::PartialEq
	}
}