v-log 0.3.0

A lightweight visual logging/debugging facade for 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
56
57
58
59
60
61

v-log
===

A Rust library providing a lightweight visual logging/debugging *facade*.

[![Build status](https://img.shields.io/github/actions/workflow/status/redweasel/v-log/main.yml?branch=main)](https://github.com/redweasel/v-log/actions)
[![Latest version](https://img.shields.io/crates/v/v-log.svg)](https://crates.io/crates/v-log)
[![Documentation](https://docs.rs/v-log/badge.svg)](https://docs.rs/v-log)
![License](https://img.shields.io/crates/l/v-log.svg)

* [`v-log` documentation](https://docs.rs/v-log)

A visual logging facade provides a single visual logging API that abstracts over the actual
visual logging implementation. Libraries can use the visual logging API provided by this
crate, and the consumer of those libraries can choose the visual logging
implementation that is most suitable for its use case.


## Minimum supported `rustc`

`1.68.0+`

This version is explicitly tested in CI and may be bumped in any release as needed. Maintaining compatibility with older compilers is a priority though, so the bar for bumping the minimum supported version is set very high. Any changes to the supported minimum version will be called out in the release notes.

## Usage

### In libraries

Libraries should link only to the `v-log` crate, and use the provided macros to
log whatever geometric information will be useful to downstream consumers:

```toml
[dependencies]
v-log = "0.3"
```

```rust
use v_log::{line, label};

pub fn shave_the_yak(yak: &mut Yak) {
    label!("yak_surface", [10.0, 10.0], (12.0, Warn, "<"), "Commencing yak shaving!");

    for (&pos1, &pos2) in &yak.lines {
        polyline!("yak_surface", (pos1, pos2), 2.0, Base);
    }
}
```

### In executables

In order to produce log output, executables have to use a vlogger implementation compatible with the facade.
Currently the following implementations exist:

- [web-vlog](https://crates.io/crates/web-vlog): renders in a webbrowser

Executables should choose a vlogger implementation and initialize it early in the
runtime of the program. Vlogger implementations will typically include a
function to do this. Any v-log messages generated before the vlogger is
initialized will be ignored.

The executable itself may use the `v-log` crate to log geometry as well.