bog 0.1.0

The highly-modular abstraction standard
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

# Bog

The highly-modular abstraction standard.

## Usage

The recommended design pattern to be used with this library is the basic type definition wrapper...

```rust
type Position = bog::Xy<u16>;
```

And implementing custom features should be done through extension traits...

```rust
trait PositionImpl {
    fn custom_x_getter(&self) -> u16;
}

impl PositionImpl for Position {
    fn custom_x_getter(&self) -> u16 {
        self.x
    }
}
```

With the following results...

```rust
let pos_a = Position::new(1, 2);

assert_eq!(pos_a.custom_x_getter(), 1);
```

## Features

| Name      | Rect | X-Y | X-Y-Z |
| :--       | :-:  | :-: | :-:   |
| `default` |✔|✔| |
| `all`     |✔|✔|✔|
| `rect`    |✔| | |
| `xy`      | |✔| |
| `xyz`     | | |✔|