refactor(errors): adopt reportable error terminology

This commit is contained in:
Onur Özkan committed 2026-08-23 00:49:25 +03:00
1 parent 21e9497915
commit 9fec2fa095
92 files changed
+270 -269

No files matched your search

@@ -9,7 +9,7 @@ version.workspace = true
workspace = true
[dependencies]
kaptan-err-propagate = { path = "../kaptan-err-propagate" }
kaptan-err-reportable = { path = "../kaptan-err-reportable" }
kaptan-log = { path = "../kaptan-log" }
kaptan-mavlink = { path = "../kaptan-mavlink", default-features = false, features = ["dialect-kaptan"] }
@@ -1,4 +1,4 @@
//! MAVLink projection for Kaptan logs and typed firmware errors.
//! MAVLink projection for Kaptan logs and reportable firmware errors.
//!
//! This adapter creates generated payload data only. A platform-owned link is
//! solely responsible for MAVLink framing, bounded admission, DMA, and retry
@@ -9,7 +9,7 @@
#[cfg(test)]
extern crate std;
use kaptan_err_propagate::ErrorRecord;
use kaptan_err_reportable::ErrorRecord;
use kaptan_log::{Level, LogRecord, MAXIMUM_LOG_TEXT_BYTES};
use kaptan_mavlink::message::kaptan::{KAPTAN_ERROR_DATA, KAPTAN_LOG_DATA, KaptanLogFlags};
@@ -32,7 +32,7 @@ pub fn encode_log(record: &LogRecord) -> KAPTAN_LOG_DATA {
}
}
/// Encodes one typed firmware error as its sole wire message.
/// Encodes one reportable firmware error as its sole wire message.
pub fn encode_error(record: &ErrorRecord) -> KAPTAN_ERROR_DATA {
let source = record.raised_at().as_bytes();
let mut length = source.len().min(ERROR_RAISED_AT_BYTES);
@@ -63,7 +63,7 @@ const fn mavlink_severity(level: Level) -> u8 {
#[cfg(test)]
mod tests {
use super::{LOG_MESSAGE_BYTES, encode_error, encode_log};
use kaptan_err_propagate::KaptanError;
use kaptan_err_reportable::KaptanError;
use kaptan_log::{Level, LogFlags, LogRecord, LogText};
use kaptan_mavlink::{
MavlinkVersion,
@@ -80,8 +80,8 @@ mod tests {
Transfer,
}
#[kaptan_err_propagate::propagate]
fn report_typed_error() -> Result<(), TestError> {
#[kaptan_err_reportable::propagate]
fn report_reportable_error() -> Result<(), TestError> {
Err(TestError::Transfer)
}
@@ -148,9 +148,9 @@ mod tests {
Ok(MavMessage::KAPTAN_LOG(decoded)) if decoded == data
));
while kaptan_err_propagate::take().is_some() {}
assert_eq!(report_typed_error(), Err(TestError::Transfer));
let error = kaptan_err_propagate::take().expect("typed error retained");
while kaptan_err_reportable::take().is_some() {}
assert_eq!(report_reportable_error(), Err(TestError::Transfer));
let error = kaptan_err_reportable::take().expect("reportable error retained");
let error_data = encode_error(&error);
assert_eq!(error_data.error_id, error.id());
assert_eq!(KAPTAN_ERROR_DATA::ENCODED_LEN, 98);