maviola/docs/
mod.rs

1#![allow(non_snake_case)]
2
3/*!
4# 📖 Maviola Playbook
5
6Maviola is a high-level [MAVLink](https://mavlink.io/en/) communication library written in Rust.
7It provides abstractions such as communication nodes and implements _stateful_ features of MAVLink
8protocol: sequencing, message signing, automatic heartbeats, and so on.
9
10This library is a part of [Mavka](https://mavka.gitlab.io/home/) toolchain. It is based on
11[Mavio](https://gitlab.com/mavka/libs/mavio), a low-level MAVLink library, and compatible with
12[MAVSpec](https://gitlab.com/mavka/libs/mavspec) MAVLink dialects generator.
13
14This documentation provides in-depth explanation of available features. We suggest to begin from
15the [Quickstart](crate::docs::a1__quickstart) and then move to other sections.
16
17If you are interested in the reasoning behind this library, we have a corresponding
18[Why Maviola?](crate::docs::a2__overview#why-maviola).
19
20## Contents
21
221. Basics
23    1. [Quickstart](crate::docs::a1__quickstart)
24    1. [Overview](crate::docs::a2__overview)
25    1. [Synchronous API](crate::docs::a3__sync_api)
26    1. [Asynchronous API](crate::docs::a4__async_api)
271. Advanced Usage
28    1. [Dialect Constraints](crate::docs::b1__dialect_constraints)
29    1. [Message Signing](crate::docs::b2__signing)
30    1. [Compatibility Checks](crate::docs::b3__compat_checks)
31    1. [Networks & Routing](crate::docs::b4__networks_and_routing)
321. Customization
33    1. [Custom Dialects](crate::docs::c1__custom_dialects)
34    1. [Custom Transport](crate::docs::c2__custom_transport)
35    1. [Custom Processing](crate::docs::c3__custom_processing)
36    1. [Ad-hoc Dialects](crate::docs::c4__ad_hoc_dialects)
371. Developer Notes
38    1. [Guidelines](crate::docs::e1__guidelines)
39    1. [Implementation Notes](crate::docs::e2__implementation)
40    1. [Testing](crate::docs::e3__testing)
41
42<em>[Quickstart →](crate::docs::a1__quickstart)</em>
43*/
44
45pub mod a1__quickstart;
46pub mod a2__overview;
47pub mod a3__sync_api;
48pub mod a4__async_api;
49pub mod b1__dialect_constraints;
50pub mod b2__signing;
51pub mod b3__compat_checks;
52pub mod b4__networks_and_routing;
53pub mod c1__custom_dialects;
54pub mod c2__custom_transport;
55pub mod c3__custom_processing;
56pub mod c4__ad_hoc_dialects;
57pub mod e1__guidelines;
58pub mod e2__implementation;
59pub mod e3__testing;
maviola/docs/mod.rs

maviola/docs/
mod.rs
