Skip to content

Commit 28d371b

Browse files
committed
Add licence and readme.
1 parent 30501e8 commit 28d371b

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2013 Mozilla Foundation
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9+
of the Software, and to permit persons to whom the Software is furnished to do
10+
so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# `bit-iter`
2+
3+
Iterate over the bits set in a word.
4+
5+
A `BitIter` may be constructed from any integral value.
6+
7+
## Example
8+
9+
```rust
10+
fn main() {
11+
use bit_iter::*;
12+
13+
let x : u32 = 0x10001;
14+
15+
for b in BitIter::from(x) {
16+
println!("Bit {} is set.", b);
17+
}
18+
}
19+
```
20+
21+
Output:
22+
23+
```text
24+
Bit 0 is set.
25+
Bit 16 is set.
26+
```

0 commit comments

Comments
 (0)