re_types_builder 0.28.2

Generates code for Rerun's SDKs from flatbuffers definitions.
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

# re_types_builder

Part of the [`rerun`](https://github.com/rerun-io/rerun) family of crates.

[![Latest version](https://img.shields.io/crates/v/re_types_builder.svg)](https://crates.io/crates/re_types_builder)
[![Documentation](https://docs.rs/re_types_builder/badge.svg)](https://docs.rs/re_types_builder)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg)

This crate implements Rerun's code generation tools.

These tools translate language-agnostic IDL definitions (flatbuffers) into code.

You can generate the code with `pixi run codegen`.

### Doclinks

The `.fbs` files can contain docstring (`///`) which in turn can contain doclinks.
They are to be written on the form `[archetypes.Image]`.

Only links to types are currently supported.

Link checking is not done by the codegen, but the output is checked implicitly by `cargo doc`, `lychee` etc.

We only support doclinks to the default `rerun.scope`.