https://github.com/darfink/tap-rs
Generic extensions for tapping values in Rust.
https://github.com/darfink/tap-rs
Last synced: 6 months ago
JSON representation
Generic extensions for tapping values in Rust.
- Host: GitHub
- URL: https://github.com/darfink/tap-rs
- Owner: darfink
- Created: 2017-06-24T22:36:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-19T14:00:25.000Z (about 6 years ago)
- Last Synced: 2024-04-18T05:51:11.788Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 17.6 KB
- Stars: 51
- Watchers: 3
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tap
[![Documentation][docs-shield]][docs]
[![crates.io version][crate-shield]][crate]
[![Language (Rust)][rust-shield]][rust]
A simple crate exposing tapping functionality for all types, and extended
functionality for `Option`, `Result` & `Future`. Often useful for logging.
The tap operation takes, and then returns, full ownership of the variable being
tapped. This means that the closure may have mutable access to the variable,
even if the variable was previously immutable. This prevents accidental mutation.
## Features
* `future` - Exposes the `TapFutureOps` trait, providing `tap_ready`,
`tap_not_ready` & `tap_err` (requires the *futures* crate).
Futures do not provide mutable access for tap closures.
* `nom3` - Exposes the `TapNomOps` trait, which provides `tap_done`,
`tap_error`, and `tap_incomplete` on their respective variants of
`nom::IResult`.
## Example
```rust
extern crate tap;
use tap::*;
fn filter_map() {
let values: &[Result] = &[Ok(3), Err("foo"), Err("bar"), Ok(8)];
let _ = values.iter().filter_map(|result| {
// It is especially useful in filter maps, allowing error information to
// be logged/printed before the information is discarded.
result.tap_err(|error| eprintln!("Invalid entry: {}", error)).ok()
});
}
fn basic() {
let mut foo = 5;
// The `tap` extension can be used on all types
if 10.tap(|v| foo += *v) > 0 {
assert_eq!(foo, 15);
}
// Results have `tap_err` & `tap_ok` available.
let _: Result = Err(5).tap_err(|e| foo = *e);
assert_eq!(foo, 5);
// Options have `tap_some` & `tap_none` available.
let _: Option = None.tap_none(|| foo = 10);
assert_eq!(foo, 10);
}
fn mutable() {
let base = [1, 2, 3];
let mutated = base.tap(|arr| for elt in arr.iter_mut() {
*elt *= 2;
});
// base was consumed and is out of scope.
assert_eq!(mutated, [2, 4, 6]);
}
```
[crate-shield]: https://img.shields.io/crates/v/tap.svg?style=flat-square
[crate]: https://crates.io/crates/tap
[rust-shield]: https://img.shields.io/badge/powered%20by-rust-blue.svg?style=flat-square
[rust]: https://www.rust-lang.org
[docs-shield]: https://img.shields.io/badge/docs-latest-green.svg?style=flat-square
[docs]: https://docs.rs/tap