likely_stable 0.1.0

likely and unlikely compiler hints in stable rust
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

[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE-MIT)
[![LICENSE](https://img.shields.io/badge/license-apache-blue.svg)](LICENSE-APACHE)
[![Documentation](https://docs.rs/static_init/badge.svg)](https://docs.rs/likely_stable)
[![Crates.io Version](https://img.shields.io/crates/v/likely_stable.svg)](https://crates.io/crates/likely_stable)

This crates brings [likely](core::intrinsics::likely) 
and [unlikely](core::intrinsics::unlikely) branch prediction hints to stable rust
```
use likely_stable::{likely,unlikely};
use rand::random;

if likely(random::<i32>() > 10) {
    println!("likely!")
} else {
    println!("unlikely!")
}
```

It also provides [macro@if_likely] and [macro@if_unlikely] for branch prediction
for `if let` statements.
```
use likely_stable::if_likely;
use rand::random;

let v = Some(random()).filter(|v:&i32| *v > 10);

if_likely!{let Some(v) = v => {
    println!("likely!")
} else {
    println!("unlikely!")
}};
```

Moreover traits [LikelyBool], [LikelyOption] and [LikelyResult] provides *likely*
and *unlikely* versions of the methods commonly used for types [bool], [Option] and
[Result]
```
use likely_stable::LikelyOption;
use rand::random;

let v = Some(random()).filter(|v:&i32| *v > 10);

v.map_or_else_likely(
    || println!("unlikely"),
    |v| println!("likely {}",v));
```

# Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
likely_stable = "0.1"
```