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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
/*! # Point-Free Inspection
The standard library does not provide a way to view or modify an expression
without binding it to a name. This module provides extension methods that take
and return a value, allowing it to be temporarily bound without creating a new
`let`-statement in the enclosing scope.
The two main uses of these methods are to temporarily attach debugging
tracepoints to an expression without modifying its surrounding code, or to
temporarily mutate an otherwise-immutable object.
For convenience, methods are available that will modify the *view* of the tapped
object that is passed to the effect function, by using the value’s
`Borrow`/`BorrowMut`, `AsRef`/`AsMut`, or `Index`/`IndexMut` trait
implementations. For example, the `Vec` collection has no `fn sort` method: this
is actually implemented on slices, to which `Vec` dereferences.
```rust
use tap::tap::*;
# fn make_vec() -> Vec<i32> { vec![] }
// taps take ordinary closures, which can use deref coercion
make_vec().tap_mut(|v| v.sort());
// `Vec<T>` implements `BorrowMut<[T]>`,
make_vec().tap_borrow_mut(<[_]>::sort);
// and `AsMut<[T]>`,
make_vec().tap_ref_mut(<[_]>::sort);
// and `DerefMut<Target = [T]>,
make_vec().tap_deref_mut(<[_]>::sort);
// but has no inherent method `sort`.
// make_vec().tap_mut(Vec::sort);
```
!*/
use core::{
borrow::{Borrow, BorrowMut},
ops::{Deref, DerefMut},
};
/** Point-free value inspection and modification.
This trait provides methods that permit viewing the value of an expression
without requiring a new `let` binding or any other alterations to the original
code other than insertion of the `.tap()` call.
The methods in this trait do not perform any view conversions on the value they
receive; it is borrowed and passed directly to the effect argument.
**/
pub trait Tap
where
Self: Sized,
{
/// Immutable access to a value.
///
/// This function permits a value to be viewed by some inspecting function
/// without affecting the overall shape of the expression that contains this
/// method call. It is useful for attaching assertions or logging points
/// into a multi-part expression.
///
/// # Examples
///
/// Here we use `.tap()` to attach logging tracepoints to each stage of a
/// value-processing pipeline.
///
/// ```rust
/// use tap::tap::Tap;
/// # struct Tmp;
/// # impl Tmp { fn process_value(self) -> Self { self } }
/// # fn make_value() -> Tmp { Tmp }
/// # macro_rules! log { ($msg:literal, $x:ident) => {{}}; }
///
/// let end = make_value()
/// // this line has no effect on the rest of the code
/// .tap(|v| log!("The produced value was: {}", v))
/// .process_value();
/// ```
#[inline(always)]
fn tap(self, func: impl FnOnce(&Self)) -> Self {
func(&self);
self
}
/// Mutable access to a value.
///
/// This function permits a value to be modified by some function without
/// affecting the overall shape of the expression that contains this method
/// call. It is useful for attaching modifier functions that have an
/// `&mut Self -> ()` signature to an expression, without requiring an
/// explicit `let mut` binding.
///
/// # Examples
///
/// Here we use `.tap_mut()` to sort an array without requring multiple
/// bindings.
///
/// ```rust
/// use tap::tap::Tap;
///
/// let sorted = [1i32, 5, 2, 4, 3]
/// .tap_mut(|arr| arr.sort());
/// assert_eq!(sorted, [1, 2, 3, 4, 5]);
/// ```
///
/// Without tapping, this would be written as
///
/// ```rust
/// let mut received = [1, 5, 2, 4, 3];
/// received.sort();
/// let sorted = received;
/// ```
///
/// The mutable tap is a convenient alternative when the expression to
/// produce the collection is more complex, for example, an iterator
/// pipeline collected into a vector.
#[inline(always)]
fn tap_mut(mut self, func: impl FnOnce(&mut Self)) -> Self {
func(&mut self);
self
}
/// Immutable access to the `Borrow<B>` of a value.
///
/// This function is identcal to [`Tap::tap`], except that the effect
/// function recevies an `&B` produced by `Borrow::<B>::borrow`, rather than
/// an `&Self`.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
#[inline(always)]
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where
Self: Borrow<B>,
B: ?Sized,
{
func(Borrow::<B>::borrow(&self));
self
}
/// Mutable access to the `BorrowMut<B>` of a value.
///
/// This function is identical to [`Tap::tap_mut`], except that the effect
/// function receives an `&mut B` produced by `BorrowMut::<B>::borrow_mut`,
/// rather than an `&mut Self`.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
#[inline(always)]
fn tap_borrow_mut<B>(mut self, func: impl FnOnce(&mut B)) -> Self
where
Self: BorrowMut<B>,
B: ?Sized,
{
func(BorrowMut::<B>::borrow_mut(&mut self));
self
}
/// Immutable access to the `AsRef<R>` view of a value.
///
/// This function is identical to [`Tap::tap`], except that the effect
/// function receives an `&R` produced by `AsRef::<R>::as_ref`, rather than
/// an `&Self`.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
#[inline(always)]
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where
Self: AsRef<R>,
R: ?Sized,
{
func(AsRef::<R>::as_ref(&self));
self
}
/// Mutable access to the `AsMut<R>` view of a value.
///
/// This function is identical to [`Tap::tap_mut`], except that the effect
/// function receives an `&mut R` produced by `AsMut::<R>::as_mut`, rather
/// than an `&mut Self`.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
#[inline(always)]
fn tap_ref_mut<R>(mut self, func: impl FnOnce(&mut R)) -> Self
where
Self: AsMut<R>,
R: ?Sized,
{
func(AsMut::<R>::as_mut(&mut self));
self
}
/// Immutable access to the `Deref::Target` of a value.
///
/// This function is identical to [`Tap::tap`], except that the effect
/// function receives an `&Self::Target` produced by `Deref::deref`, rather
/// than an `&Self`.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
#[inline(always)]
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where
Self: Deref<Target = T>,
T: ?Sized,
{
func(Deref::deref(&self));
self
}
/// Mutable access to the `Deref::Target` of a value.
///
/// This function is identical to [`Tap::tap_mut`], except that the effect
/// function receives an `&mut Self::Target` produced by
/// `DerefMut::deref_mut`, rather than an `&mut Self`.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
#[inline(always)]
fn tap_deref_mut<T>(mut self, func: impl FnOnce(&mut T)) -> Self
where
Self: DerefMut + Deref<Target = T>,
T: ?Sized,
{
func(DerefMut::deref_mut(&mut self));
self
}
// debug-build-only copies of the above methods
/// Calls `.tap()` only in debug builds, and is erased in release builds.
#[inline(always)]
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self {
if cfg!(debug_assertions) {
func(&self);
}
self
}
/// Calls `.tap_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_mut_dbg(mut self, func: impl FnOnce(&mut Self)) -> Self {
if cfg!(debug_assertions) {
func(&mut self);
}
self
}
/// Calls `.tap_borrow()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where
Self: Borrow<B>,
B: ?Sized,
{
if cfg!(debug_assertions) {
func(Borrow::<B>::borrow(&self));
}
self
}
/// Calls `.tap_borrow_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_borrow_mut_dbg<B>(mut self, func: impl FnOnce(&mut B)) -> Self
where
Self: BorrowMut<B>,
B: ?Sized,
{
if cfg!(debug_assertions) {
func(BorrowMut::<B>::borrow_mut(&mut self));
}
self
}
/// Calls `.tap_ref()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where
Self: AsRef<R>,
R: ?Sized,
{
if cfg!(debug_assertions) {
func(AsRef::<R>::as_ref(&self));
}
self
}
/// Calls `.tap_ref_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_ref_mut_dbg<R>(mut self, func: impl FnOnce(&mut R)) -> Self
where
Self: AsMut<R>,
R: ?Sized,
{
if cfg!(debug_assertions) {
func(AsMut::<R>::as_mut(&mut self));
}
self
}
/// Calls `.tap_deref()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where
Self: Deref<Target = T>,
T: ?Sized,
{
if cfg!(debug_assertions) {
func(Deref::deref(&self));
}
self
}
/// Calls `.tap_deref_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_deref_mut_dbg<T>(mut self, func: impl FnOnce(&mut T)) -> Self
where
Self: DerefMut + Deref<Target = T>,
T: ?Sized,
{
if cfg!(debug_assertions) {
func(DerefMut::deref_mut(&mut self));
}
self
}
}
impl<T> Tap for T where T: Sized {}
/** Optional tapping, conditional on the optional presence of a value.
This trait is intended for use on types that express the concept of “optional
presence”, primarily the [`Option`] monad. It provides taps that inspect the
container to determine if the effect function should execute or not.
> Note: This trait is a specialization of [`TapFallible`], and exists because
> the [`std::ops::Try`] trait is still unstable. When `Try` stabilizes, this
> trait can be removed, and `TapFallible` blanket-applied to all `Try`
> implementors.
[`Option`]: https://doc.rust-lang.org/std/option/enum.Option.html
[`TapFallible`]: trait.TapFallible.html
[`std::ops::Try`]: https://doc.rust-lang.org/std/ops/trait.Try.html
**/
pub trait TapOptional
where
Self: Sized,
{
/// The interior type that the container may or may not carry.
type Val: ?Sized;
/// Immutabily accesses an interior value only when it is present.
///
/// This function is identical to [`Tap::tap`], except that it is required
/// to check the implementing container for value presence before running.
/// Implementors must not run the effect function if the container is marked
/// as being empty.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
fn tap_some(self, func: impl FnOnce(&Self::Val)) -> Self;
/// Mutably accesses an interor value only when it is present.
///
/// This function is identical to [`Tap::tap_mut`], except that it is
/// required to check the implementing container for value presence before
/// running. Implementors must not run the effect function if the container
/// is marked as being empty.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
fn tap_some_mut(self, func: impl FnOnce(&mut Self::Val)) -> Self;
/// Runs an effect function when the container is empty.
///
/// This function is identical to [`Tap::tap`], except that it is required
/// to check the implementing container for value absence before running.
/// Implementors must not run the effect function if the container is marked
/// as being non-empty.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
fn tap_none(self, func: impl FnOnce()) -> Self;
/// Calls `.tap_some()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_some_dbg(self, func: impl FnOnce(&Self::Val)) -> Self {
if cfg!(debug_assertions) {
self.tap_some(func)
} else {
self
}
}
/// Calls `.tap_some_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_some_mut_dbg(self, func: impl FnOnce(&mut Self::Val)) -> Self {
if cfg!(debug_assertions) {
self.tap_some_mut(func)
} else {
self
}
}
/// Calls `.tap_none()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_none_dbg(self, func: impl FnOnce()) -> Self {
if cfg!(debug_assertions) {
self.tap_none(func)
} else {
self
}
}
}
impl<T> TapOptional for Option<T> {
type Val = T;
#[inline(always)]
fn tap_some(self, func: impl FnOnce(&T)) -> Self {
if let Some(ref val) = self {
func(val);
}
self
}
#[inline(always)]
fn tap_some_mut(mut self, func: impl FnOnce(&mut T)) -> Self {
if let Some(ref mut val) = self {
func(val);
}
self
}
#[inline(always)]
fn tap_none(self, func: impl FnOnce()) -> Self {
if self.is_none() {
func();
}
self
}
}
/** Fallible tapping, conditional on the optional success of an expression.
This trait is intended for use on types that express the concept of “fallible
presence”, primarily the [`Result`] monad. It provides taps that inspect the
container to determine if the effect function should execute or not.
> Note: This trait would ideally be implemented as a blanket over all
> [`std::ops::Try`] implementors. When `Try` stabilizes, this crate can be
> updated to do so.
[`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html
[`std::ops::Try`]: https://doc.rust-lang.org/std/ops/trait.Try.html
**/
pub trait TapFallible
where
Self: Sized,
{
/// The interior type used to indicate a successful construction.
type Ok: ?Sized;
/// The interior type used to indicate a failed construction.
type Err: ?Sized;
/// Immutably accesses an interior success value.
///
/// This function is identical to [`Tap::tap`], except that it is required
/// to check the implementing container for value success before running.
/// Implementors must not run the effect function if the container is marked
/// as being a failure.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
fn tap_ok(self, func: impl FnOnce(&Self::Ok)) -> Self;
/// Mutably accesses an interior success value.
///
/// This function is identical to [`Tap::tap_mut`], except that it is
/// required to check the implementing container for value success before
/// running. Implementors must not run the effect function if the container
/// is marked as being a failure.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
fn tap_ok_mut(self, func: impl FnOnce(&mut Self::Ok)) -> Self;
/// Immutably accesses an interior failure value.
///
/// This function is identical to [`Tap::tap`], except that it is required
/// to check the implementing container for value failure before running.
/// Implementors must not run the effect function if the container is marked
/// as being a success.
///
/// [`Tap::tap`]: trait.Tap.html#method.tap
fn tap_err(self, func: impl FnOnce(&Self::Err)) -> Self;
/// Mutably accesses an interior failure value.
///
/// This function is identical to [`Tap::tap_mut`], except that it is
/// required to check the implementing container for value failure before
/// running. Implementors must not run the effect function if the container
/// is marked as being a success.
///
/// [`Tap::tap_mut`]: trait.Tap.html#method.tap_mut
fn tap_err_mut(self, func: impl FnOnce(&mut Self::Err)) -> Self;
/// Calls `.tap_ok()` only in debug builds, and is erased in release builds.
#[inline(always)]
fn tap_ok_dbg(self, func: impl FnOnce(&Self::Ok)) -> Self {
if cfg!(debug_assertions) {
self.tap_ok(func)
} else {
self
}
}
/// Calls `.tap_ok_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_ok_mut_dbg(self, func: impl FnOnce(&mut Self::Ok)) -> Self {
if cfg!(debug_assertions) {
self.tap_ok_mut(func)
} else {
self
}
}
/// Calls `.tap_err()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_err_dbg(self, func: impl FnOnce(&Self::Err)) -> Self {
if cfg!(debug_assertions) {
self.tap_err(func)
} else {
self
}
}
/// Calls `.tap_err_mut()` only in debug builds, and is erased in release
/// builds.
#[inline(always)]
fn tap_err_mut_dbg(self, func: impl FnOnce(&mut Self::Err)) -> Self {
if cfg!(debug_assertions) {
self.tap_err_mut(func)
} else {
self
}
}
}
impl<T, E> TapFallible for Result<T, E> {
type Ok = T;
type Err = E;
#[inline(always)]
fn tap_ok(self, func: impl FnOnce(&T)) -> Self {
if let Ok(ref val) = self {
func(val);
}
self
}
#[inline(always)]
fn tap_ok_mut(mut self, func: impl FnOnce(&mut T)) -> Self {
if let Ok(ref mut val) = self {
func(val);
}
self
}
#[inline(always)]
fn tap_err(self, func: impl FnOnce(&E)) -> Self {
if let Err(ref val) = self {
func(val);
}
self
}
#[inline(always)]
fn tap_err_mut(mut self, func: impl FnOnce(&mut E)) -> Self {
if let Err(ref mut val) = self {
func(val);
}
self
}
}