rust/sat-rs
rust/sat-rs
5
1
Fork 0
Code Issues 9 Pull Requests 1 Projects Releases 21 Wiki Activity

Merge pull request 'MIB docs update' (#118) from mib-docs-update into main
All checks were successful
Rust/sat-rs/pipeline/head This commit looks good
Details

Browse Source 
Reviewed-on: #118
This commit is contained in:
Robin Müller 2024-02-12 18:11:54 +01:00
commit 3a6cd6712d
3 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
satrs-mib/README.md
View File

@ -1,3 +1,6 @@
[![Crates.io](https://img.shields.io/crates/v/satrs-mib)](https://crates.io/crates/satrs-mib)
[![docs.rs](https://img.shields.io/docsrs/satrs-mib)](https://docs.rs/satrs-mib)
satrs-mib satrs-mib
========= =========

6
satrs-mib/codegen/src/lib.rs
View File

@ -1,6 +1,12 @@
use quote::{format_ident, quote, ToTokens}; use quote::{format_ident, quote, ToTokens};
use syn::{parse_macro_input, ItemConst, LitStr}; use syn::{parse_macro_input, ItemConst, LitStr};
/// This macro can be used to automatically generate introspection information for return codes.
///
/// For example, it can be applied to types like the [satrs_shared::res_code::ResultU16] type
/// to automatically generate [satrs_mib::res_code::ResultU16Info] instances. These instances
/// can then be used for tasks like generating CSVs or YAML files with the list of all result
/// codes. This information is valuable for both operators and developers.
#[proc_macro_attribute] #[proc_macro_attribute]
pub fn resultcode( pub fn resultcode(
args: proc_macro::TokenStream, args: proc_macro::TokenStream,

1
satrs-mib/src/res_code.rs
View File

@ -73,6 +73,7 @@ pub mod stdmod {
Ok(()) Ok(())
} }
/// This function exports a slice of result code information objects to a CSV file.
pub fn write_resultcodes_to_csv( pub fn write_resultcodes_to_csv(
writer_builder: csv::WriterBuilder, writer_builder: csv::WriterBuilder,
results: &[ResultU16Info], results: &[ResultU16Info],