impl_more/deref.rs
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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
/// Implement [`Deref`] for a struct.
///
/// The first argument is that of the newtype struct to create the impl for and the second is the
/// deref target type. The third argument is required for non-newtype structs and is the name of the
/// field to deref to. Type parameters require special handling, see examples.
///
/// Also see [`impl_deref_mut`], [`impl_deref_and_mut`], and [`forward_deref_and_mut`].
///
/// # Examples
/// With a newtype struct:
/// ```
/// struct Foo(String);
/// impl_more::impl_deref!(Foo => String);
///
/// let mut foo = Foo("bar".to_owned());
/// assert_eq!(foo.len(), 3);
/// ```
///
/// With a named field struct and type parameter:
/// ```
/// struct MyStruct<T> { msg: T };
/// impl_more::impl_deref!(<T> in MyStruct<T> => msg: T);
///
/// let foo = MyStruct { msg: "two".to_owned() };
/// assert_eq!(foo.len(), 3);
/// ```
///
/// [`Deref`]: core::ops::Deref
/// [`impl_deref_mut`]: crate::impl_deref_mut
/// [`impl_deref_and_mut`]: crate::impl_deref_and_mut
/// [`forward_deref_and_mut`]: crate::forward_deref_and_mut
#[macro_export]
macro_rules! impl_deref {
(<$($generic:ident),+> in $this:ty => $target:ty) => {
impl <$($generic),+> ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.0
}
}
};
(<$($generic:ident),+> in $this:ty => $field:ident : $target:ty) => {
impl <$($generic),+> ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.$field
}
}
};
($this:ty => $target:ty) => {
impl ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.0
}
}
};
($this:ty => $field:ident : $target:ty) => {
impl ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.$field
}
}
};
}
/// Implement [`DerefMut`] for a struct.
///
/// The first argument is that of the struct to create the impl for and this type must also
/// implement [`Deref`]. The second argument is required for non-newtype structs and is the field
/// to deref to.
///
/// This macro has the same type parameter support and format as [`impl_deref`].
///
/// Also see [`impl_deref`], [`impl_deref_and_mut`], and [`forward_deref_and_mut`].
///
/// # Examples
/// With a newtype struct:
/// ```
/// use impl_more::{impl_deref, impl_deref_mut};
///
/// struct Foo(String);
///
/// impl_deref!(Foo => String);
/// impl_deref_mut!(Foo);
///
/// let mut foo = Foo("bar".to_owned());
/// foo.push('!');
///
/// assert_eq!(*foo, "bar!");
/// ```
///
/// With a named field struct and type parameter:
/// ```
/// struct Foo<T> { msg: T };
/// impl_more::impl_deref!(<T> in Foo<T> => msg: T);
/// impl_more::impl_deref_mut!(<T> in Foo<T> => msg);
///
/// let mut foo = Foo { msg: "bar".to_owned() };
/// foo.push('!');
///
/// assert_eq!(*foo, "bar!");
/// ```
///
/// [`Deref`]: core::ops::Deref
/// [`DerefMut`]: core::ops::DerefMut
/// [`impl_deref`]: crate::impl_deref
/// [`impl_deref_and_mut`]: crate::impl_deref_and_mut
/// [`forward_deref_and_mut`]: crate::forward_deref_and_mut
#[macro_export]
macro_rules! impl_deref_mut {
(<$($generic:ident),+> in $this:ty) => {
impl <$($generic),+> ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
};
(<$($generic:ident),+> in $this:ty => $field:ident) => {
impl <$($generic),+> ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.$field
}
}
};
($this:ty) => {
impl ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
};
($this:ty => $field:ident) => {
impl ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.$field
}
}
};
}
/// Implements [`Deref`] and [`DerefMut`] by forwarding through an inner field's implementation.
///
/// Use the `ref <type>` form for deref-ing to types with lifetimes like `&str`. For newtype
/// structs, only the struct name and deref target type is necessary.
///
/// This macro has the same type parameter support and format as [`impl_deref`].
///
/// Also see [`forward_deref_and_mut`].
///
/// # Examples
/// ```
/// struct MyNewTypeStruct(String);
/// impl_more::impl_deref_and_mut!(MyNewTypeStruct => String);
///
/// let foo = MyNewTypeStruct("one".to_owned());
/// let foo_ref: &String = &foo;
///
/// // Unlike `forward_deref_and_mut`, this macro will not forward the deref implementation
/// // through the named type. Even so, in some cases Rust will be able to support these cases.
///
/// let foo_ref: &str = &foo;
///
/// fn accepts_string_slice(_: &str) {}
/// accepts_string_slice(&foo);
/// ```
///
/// [`Deref`]: core::ops::Deref
/// [`DerefMut`]: core::ops::DerefMut
/// [`impl_deref`]: crate::impl_deref
/// [`forward_deref_and_mut`]: crate::forward_deref_and_mut
#[macro_export]
macro_rules! impl_deref_and_mut {
(<$($generic:ident),+> in $this:ty => $target:ty) => {
impl <$($generic),+> ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl <$($generic),+> ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
};
(<$($generic:ident),+> in $this:ty => $field:ident : $target:ty) => {
impl <$($generic),+> ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.$field
}
}
impl <$($generic),+> ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.$field
}
}
};
($this:ty => $target:ty) => {
impl ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
};
($this:ty => $field:ident : $target:ty) => {
impl ::core::ops::Deref for $this {
type Target = $target;
fn deref(&self) -> &Self::Target {
&self.$field
}
}
impl ::core::ops::DerefMut for $this {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.$field
}
}
};
}
/// Implements [`Deref`] and [`DerefMut`] by forwarding through an inner field's implementation.
///
/// Use the `ref <type>` form for deref-ing to types with lifetimes like `&str`. For newtype
/// structs, only the struct name and deref target type is necessary.
///
/// Also see [`impl_deref_and_mut`].
///
/// # Examples
/// With a newtype struct:
/// ```
/// # fn accepts_string_slice(_: &str) {}
/// # fn accepts_mut_string_slice(_: &mut str) {}
/// #
/// struct MyNewTypeStruct(String);
/// impl_more::forward_deref_and_mut!(MyNewTypeStruct => ref str);
/// let mut foo = MyNewTypeStruct("one".to_owned());
/// let foo_ref: &str = &foo;
/// accepts_string_slice(&foo);
/// accepts_mut_string_slice(&mut foo);
/// ```
///
/// [`impl_deref_and_mut`]: crate::impl_deref_and_mut
/// [`Deref`]: core::ops::Deref
/// [`DerefMut`]: core::ops::DerefMut
#[macro_export]
macro_rules! forward_deref_and_mut {
($ty:ty => $target:ty) => {
impl ::core::ops::Deref for $ty {
type Target = $target;
fn deref(&self) -> &Self::Target {
::core::ops::Deref::deref(&self.0)
}
}
impl ::core::ops::DerefMut for $ty {
fn deref_mut(&mut self) -> &mut Self::Target {
::core::ops::DerefMut::deref_mut(&mut self.0)
}
}
};
($ty:ty => ref $target:ty) => {
impl<'__impl_more_a> ::core::ops::Deref for $ty {
type Target = $target;
fn deref(&self) -> &Self::Target {
::core::ops::Deref::deref(&self.0)
}
}
impl<'__impl_more_a> ::core::ops::DerefMut for $ty {
fn deref_mut(&mut self) -> &mut Self::Target {
::core::ops::DerefMut::deref_mut(&mut self.0)
}
}
};
($ty:ty => $field:ident : $target:ty) => {
impl ::core::ops::Deref for $ty {
type Target = $target;
fn deref(&self) -> &Self::Target {
::core::ops::Deref::deref(&self.$field)
}
}
impl ::core::ops::DerefMut for $ty {
fn deref_mut(&mut self) -> &mut Self::Target {
::core::ops::DerefMut::deref_mut(&mut self.$field)
}
}
};
($ty:ty => $field:ident : ref $target:ty) => {
impl<'__impl_more_a> ::core::ops::Deref for $ty {
type Target = $target;
fn deref(&self) -> &Self::Target {
::core::ops::Deref::deref(&self.$field)
}
}
impl<'__impl_more_a> ::core::ops::DerefMut for $ty {
fn deref_mut(&mut self) -> &mut Self::Target {
::core::ops::DerefMut::deref_mut(&mut self.$field)
}
}
};
}
#[cfg(test)]
mod tests {
#![allow(dead_code)]
use alloc::{borrow::ToOwned as _, string::String};
use core::ops::{Deref, DerefMut};
fn accepts_string_slice(_: &str) {}
fn accepts_mut_string_slice(_: &mut str) {}
struct Foo1(String);
impl_deref_and_mut!(Foo1 => String);
static_assertions::assert_impl_all!(
Foo1:
// impls
Deref<Target = String>,
DerefMut<Target = String>,
);
struct Foo2(String);
forward_deref_and_mut!(Foo2 => ref str);
static_assertions::assert_impl_all!(
Foo2:
// impls
Deref,
DerefMut,
);
struct SingleGeneric<T>(T);
impl_deref!(<T> in SingleGeneric<T> => T);
impl_deref_mut!(<T> in SingleGeneric<T>);
static_assertions::assert_impl_all!(
SingleGeneric<usize>:
// impls
Deref<Target = usize>,
DerefMut<Target = usize>,
);
struct SingleGenericCombined<T>(T);
impl_deref_and_mut!(<T> in SingleGenericCombined<T> => T);
static_assertions::assert_impl_all!(
SingleGenericCombined<usize>:
// impls
Deref<Target = usize>,
DerefMut<Target = usize>,
);
struct DoubleGeneric<T, U> {
t: T,
_u: U,
}
impl_deref!(<T, U> in DoubleGeneric<T, U> => t: T);
impl_deref_mut!(<T, U> in DoubleGeneric<T, U> => t);
static_assertions::assert_impl_all!(
DoubleGeneric<usize, u32>:
// impls
Deref<Target = usize>,
DerefMut<Target = usize>,
);
struct DoubleGenericCombined<T, U> {
t: T,
_u: U,
}
impl_deref_and_mut!(<T, U> in DoubleGenericCombined<T, U> => t: T);
static_assertions::assert_impl_all!(
DoubleGenericCombined<usize, u32>:
// impls
Deref<Target = usize>,
DerefMut<Target = usize>,
);
#[test]
fn foo2_impls() {
let mut foo = Foo2("".to_owned());
accepts_string_slice(&foo);
accepts_mut_string_slice(&mut foo);
}
struct Foo3 {
msg: String,
}
forward_deref_and_mut!(Foo3 => msg: ref str);
static_assertions::assert_impl_all!(
Foo3:
// impls
Deref,
DerefMut,
);
#[test]
fn foo3_impls() {
let mut foo = Foo3 { msg: "".to_owned() };
accepts_string_slice(&foo);
accepts_mut_string_slice(&mut foo);
}
}