secop-derive 0.1.3

A Rust framework for a hardware server speaking the SECoP protocol (derive package)
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

// -----------------------------------------------------------------------------
// Rust SECoP playground
//
// This program is free software; you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free Software
// Foundation; either version 2 of the License, or (at your option) any later
// version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
// details.
//
// You should have received a copy of the GNU General Public License along with
// this program; if not, write to the Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// Module authors:
//   Georg Brandl <g.brandl@fz-juelich.de>
//
// -----------------------------------------------------------------------------
//
//! # Derive support for secop modules
//!
//! There are two auto-derive traits implemented here:
//!
//! * `ModuleBase` is a complete implementation of the guts of a module.  It
//!   provides an easy DSL to add parameters and commands, and translates that
//!   into the respective case handling in the methods that implement the
//!   basic SECoP actions like `change` and `do`.
//!
//!   It also provides automatic translation and verification between JSON
//!   payloads and Rust data for parameter and argument types.
//!
//! * `TypeDesc` can be derived for enums and structs, and provides a type-
//!   safe way to declare parameters and commands with enum and struct
//!   datatypes.

mod module;
mod typedesc;

use synstructure::decl_derive;

decl_derive!([ModuleBase, attributes(param, command)] => crate::module::derive_module);
decl_derive!([TypeDesc, attributes(datatype)] => crate::typedesc::derive_typedesc);