sergeysav/ProjectNautilus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

lint

Browse Source
This commit is contained in:
Sergey Savelyev
2025-10-26 09:24:49 -07:00
parent 5455935f3a
commit eefc3293b4
36 changed files with 886 additions and 516 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
common/src/lib.rs
View File

@@ -1,12 +1,20 @@
#![warn(
clippy::all,
clippy::pedantic,
)]
use log::info;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
pub mod logger;
pub mod command;
pub mod logger;
pub mod telemetry;
pub mod udp;
/// Add a ctrl-c handler which will set an atomic flag to `false` when ctrl-c is detected
///
/// # Errors
/// If a system error occurred while trying to set the ctrl-c handler
pub fn add_ctrlc_handler(flag: Arc<AtomicBool>) -> anyhow::Result<()> {
ctrlc::set_handler(move || {
info!("Shutdown Requested");

8
common/src/logger.rs
View File

@@ -5,6 +5,10 @@ use std::fs::create_dir_all;
use std::str::FromStr;
use std::{env, thread};
/// Set up the logger with a given package name
///
/// # Errors
/// If an error occurred while trying to set up the logger
pub fn setup_logger(package_name: &'static str) -> Result<()> {
let log_file = env::var("LOG_FILE").or_else(|_| {
create_dir_all("logs/")?;
@@ -37,7 +41,7 @@ pub fn setup_logger(package_name: &'static str) -> Result<()> {
level = colors.color(record.level()),
time = chrono::Local::now().format("%Y-%m-%dT%H:%M:%S%.9f"),
target = record.target(),
))
));
})
.chain(
fern::Dispatch::new()
@@ -47,6 +51,6 @@ pub fn setup_logger(package_name: &'static str) -> Result<()> {
.chain(fern::log_file(log_file.clone())?)
.apply()?;
debug!("Logging to {} at level {}", log_file, log_level);
debug!("Logging to {log_file} at level {log_level}");
Ok(())
}

2
common/src/telemetry/mod.rs
View File

@@ -20,5 +20,5 @@ pub enum TelemetryMessage {
SwitchState {
bank: SwitchBank,
switches: [bool; 16],
}
},
}

94
common/src/udp.rs
View File

@@ -1,7 +1,7 @@
use crate::udp::UdpSendCborError::LengthMismatch;
use log::error;
use serde::de::DeserializeOwned;
use serde::Serialize;
use serde::de::DeserializeOwned;
use std::io::{Cursor, ErrorKind};
use std::net::{SocketAddr, ToSocketAddrs, UdpSocket};
use thiserror::Error;
@@ -23,58 +23,76 @@ pub enum UdpSendCborError {
#[error("Serialization Error")]
Serialization(#[from] ciborium::ser::Error<std::io::Error>),
#[error("Length Mismatch")]
LengthMismatch {
expected: usize,
actual: usize,
},
LengthMismatch { expected: usize, actual: usize },
}
pub trait UdpSocketExt {
fn recv_cbor<T: DeserializeOwned, const N: usize>(&self, buffer: &mut Cursor<[u8; N]>) -> Result<(T, SocketAddr), UdpRecvCborError>;
fn send_cbor<T: Serialize + ?Sized, A: ToSocketAddrs, const N: usize>(&self, data: &T, buffer: &mut Cursor<[u8; N]>, addr: A) -> Result<(), UdpSendCborError>;
/// Receive a CBOR encoded message from this UDP Socket
///
/// # Errors
/// An error that could have occurred while trying to receive this message.
/// If no data was received a `UdpRecvCborError::NoData` error would be returned.
fn recv_cbor<T: DeserializeOwned, const N: usize>(
&self,
buffer: &mut Cursor<[u8; N]>,
) -> Result<(T, SocketAddr), UdpRecvCborError>;
/// Send a CBOR encoded message to an address using this socket
///
/// # Errors
/// An error that could have occurred while trying to send this message
fn send_cbor<T: Serialize + ?Sized, A: ToSocketAddrs, const N: usize>(
&self,
data: &T,
buffer: &mut Cursor<[u8; N]>,
addr: A,
) -> Result<(), UdpSendCborError>;
}
impl UdpSocketExt for UdpSocket {
fn recv_cbor<T: DeserializeOwned, const N: usize>(&self, buffer: &mut Cursor<[u8; N]>) -> Result<(T, SocketAddr), UdpRecvCborError> {
fn recv_cbor<T: DeserializeOwned, const N: usize>(
&self,
buffer: &mut Cursor<[u8; N]>,
) -> Result<(T, SocketAddr), UdpRecvCborError> {
buffer.set_position(0);
match self.recv_from(buffer.get_mut()) {
Ok((size, addr)) => {
match ciborium::from_reader::<T, _>(&buffer.get_ref()[..size]) {
Ok(res) => Ok((res, addr)),
Err(err) => Err(err.into()),
}
}
Err(err) => {
match err.kind() {
ErrorKind::WouldBlock | ErrorKind::TimedOut => {
Err(UdpRecvCborError::NoData)
}
_ => Err(err.into())
}
}
Ok((size, addr)) => match ciborium::from_reader::<T, _>(&buffer.get_ref()[..size]) {
Ok(res) => Ok((res, addr)),
Err(err) => Err(err.into()),
},
Err(err) => match err.kind() {
ErrorKind::WouldBlock | ErrorKind::TimedOut => Err(UdpRecvCborError::NoData),
_ => Err(err.into()),
},
}
}
fn send_cbor<T: Serialize + ?Sized, A: ToSocketAddrs, const N: usize>(&self, data: &T, mut buffer: &mut Cursor<[u8; N]>, addr: A) -> Result<(), UdpSendCborError> {
fn send_cbor<T: Serialize + ?Sized, A: ToSocketAddrs, const N: usize>(
&self,
data: &T,
mut buffer: &mut Cursor<[u8; N]>,
addr: A,
) -> Result<(), UdpSendCborError> {
buffer.set_position(0);
match ciborium::into_writer(data, &mut buffer) {
Ok(_) => match self.send_to(&buffer.get_ref()[..buffer.position() as usize], addr) {
Ok(size) => {
if buffer.position() as usize != size {
return Err(LengthMismatch {
expected: buffer.position() as usize,
actual: size,
});
Ok(()) => {
let size_encoded = usize::try_from(buffer.position())
.expect("Values greater than u32 are not expected anyway");
match self.send_to(&buffer.get_ref()[..size_encoded], addr) {
Ok(size_sent) => {
if size_encoded != size_sent {
return Err(LengthMismatch {
expected: size_encoded,
actual: size_sent,
});
}
Ok(())
}
Ok(())
Err(e) => Err(e.into()),
}
Err(e) => {
Err(e.into())
}
}
Err(e) => {
Err(e.into())
}
},
Err(e) => Err(e.into()),
}
}
}