#pipe #traits #pipeline #fp #deref-mut

no-std pipe-trait

Make it possible to chain regular functions

17 releases

0.4.0 Jan 24, 2022
0.3.3 Jan 22, 2022
0.3.2 Apr 8, 2021
0.3.1 Mar 25, 2021
0.1.11 May 23, 2020

#441 in Rust patterns

Download history 1574/week @ 2023-12-04 1159/week @ 2023-12-11 1041/week @ 2023-12-18 237/week @ 2023-12-25 1197/week @ 2024-01-01 1332/week @ 2024-01-08 890/week @ 2024-01-15 1750/week @ 2024-01-22 1305/week @ 2024-01-29 1287/week @ 2024-02-05 955/week @ 2024-02-12 818/week @ 2024-02-19 926/week @ 2024-02-26 1480/week @ 2024-03-04 1199/week @ 2024-03-11 1069/week @ 2024-03-18

4,731 downloads per month
Used in 20 crates (14 directly)

MIT license

13KB
181 lines

Pipe Trait

Test Crates.io Version

Make it possible to chain regular functions.

APIs

By adding use pipe_trait::*, 9 methods are added to all types:

identifier pipe syntax traditional syntax
Pipe::pipe x.pipe(f) f(x)
Pipe::pipe_ref x.pipe_ref(f) f(&x)
Pipe::pipe_mut x.pipe_mut(f) f(&mut x)
Pipe::pipe_as_ref x.pipe_as_ref(f) f(x.as_ref())
Pipe::pipe_as_mut x.pipe_as_mut(f) f(x.as_mut())
Pipe::pipe_deref x.pipe_deref(f) f(&x)
Pipe::pipe_deref_mut x.pipe_deref_mut(f) f(&mut x)
Pipe::pipe_borrow x.pipe_borrow(f) f(x.borrow())
Pipe::pipe_borrow_mut x.pipe_borrow_mut(f) f(x.borrow_mut())

Read the docs for more information.

Usage Examples

Same type

use pipe_trait::*;
let inc = |x| x + 1;
let double = |x| x + x;
let square = |x| x * x;
let a = (123i32).pipe(inc).pipe(double).pipe(square);
let b = square(double(inc(123i32)));
assert_eq!(a, b);

Type transformation

use pipe_trait::*;
let x = 'x';
let a = x
    .pipe(|x| (x, x, x)) // (char, char, char)
    .pipe(|x| [x, x]) // [(char, char, char); 2]
    .pipe(|x| format!("{:?}", x)); // String
let b = "[('x', 'x', 'x'), ('x', 'x', 'x')]";
assert_eq!(a, b);

Pipe amongst method chain

use pipe_trait::*;
fn log<X: Debug>(x: X) -> X {
    println!("value: {:?}", x);
    x
}
my_future
    .pipe(log)
    .await
    .pipe(log)
    .inc()
    .pipe(log)
    .double()
    .pipe(log)
    .square()
    .pipe(log)
    .get()
    .pipe(log);

Explicit type annotation

use pipe_trait::*;
let x = "abc".to_string();
let a = x
    .pipe_ref::<&str, _>(AsRef::as_ref)
    .chars()
    .pipe::<Box<_>, _>(Box::new)
    .collect::<Vec<_>>();
let b = vec!['a', 'b', 'c'];
assert_eq!(a, b);

License

MIT © Hoàng Văn Khải

No runtime deps