Skip to content

Allow to disable logging #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flosse merged 2 commits into from
Sep 21, 2025
Merged

Allow to disable logging #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84dc855
Allow to disable logging
Abestanis Sep 17, 2025
b24deb6
Use let Err() instead of inspect_err
Abestanis Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ tcp = []
rtu = []
std = ["byteorder/std"]
defmt = ["dep:defmt"]
# Enable decoding error logging.
log = ["dep:log"]

[dependencies]
log = { version = "0.4.28" }
log = { version = "0.4.28", optional = true }
byteorder = { version = "1.5.0", default-features = false }

[target.'cfg(target_os = "none")'.dependencies]
Expand Down
14 changes: 8 additions & 6 deletions src/codec/rtu/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,16 @@ pub fn decode_response(buf: &[u8]) -> Result<Option<ResponseAdu<'_>>> {
// to transmission errors, because the frame's bytes
// have already been verified with the CRC.

ExceptionResponse::try_from(pdu)
let response = ExceptionResponse::try_from(pdu)
.map(|er| ResponsePdu(Err(er)))
.or_else(|_| Response::try_from(pdu).map(|r| ResponsePdu(Ok(r))))
.map(|pdu| Some(ResponseAdu { hdr, pdu }))
.inspect_err(|&err| {
// Unrecoverable error
log::error!("Failed to decode Response PDU: {err}");
})
.map(|pdu| Some(ResponseAdu { hdr, pdu }));
#[cfg(feature = "log")]
if let Err(error) = response {
// Unrecoverable error
log::error!("Failed to decode Response PDU: {error}");
}
response
})
.map_err(|_| {
// Decoding the transport frame is non-destructive and must
Expand Down
2 changes: 2 additions & 0 deletions src/codec/rtu/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,14 @@ pub fn decode(
})
.or_else(|err| {
if drop_cnt + 1 >= MAX_FRAME_LEN {
#[cfg(feature = "log")]
log::error!(
"Giving up to decode frame after dropping {drop_cnt} byte(s): {:X?}",
&buf[0..drop_cnt]
);
return Err(err);
}
#[cfg(feature = "log")]
log::warn!(
"Failed to decode {} frame: {err}",
match decoder_type {
Expand Down
15 changes: 9 additions & 6 deletions src/codec/rtu/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ pub fn decode_request(buf: &[u8]) -> Result<Option<RequestAdu<'_>>> {
// Decoding of the PDU should are unlikely to fail due
// to transmission errors, because the frame's bytes
// have already been verified with the CRC.
Request::try_from(pdu)
let request = Request::try_from(pdu)
.map(RequestPdu)
.map(|pdu| Some(RequestAdu { hdr, pdu }))
.inspect_err(|&err| {
// Unrecoverable error
log::error!("Failed to decode request PDU: {err}");
})
.map(|pdu| Some(RequestAdu { hdr, pdu }));

#[cfg(feature = "log")]
if let Err(error) = request {
// Unrecoverable error
log::error!("Failed to decode request PDU: {error}");
}
request
})
.map_err(|_| {
// Decoding the transport frame is non-destructive and must
Expand Down
15 changes: 8 additions & 7 deletions src/codec/tcp/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,16 @@ pub fn decode_response(buf: &[u8]) -> Result<Option<ResponseAdu<'_>>> {
// Decoding of the PDU should are unlikely to fail due
// to transmission errors, because the frame's bytes
// have already been verified with the CRC.

ExceptionResponse::try_from(pdu)
let response = ExceptionResponse::try_from(pdu)
.map(|er| ResponsePdu(Err(er)))
.or_else(|_| Response::try_from(pdu).map(|r| ResponsePdu(Ok(r))))
.map(|pdu| Some(ResponseAdu { hdr, pdu }))
.inspect_err(|&err| {
// Unrecoverable error
log::error!("Failed to decode Response PDU: {err}");
})
.map(|pdu| Some(ResponseAdu { hdr, pdu }));
#[cfg(feature = "log")]
if let Err(error) = response {
// Unrecoverable error
log::error!("Failed to decode Response PDU: {error}");
}
response
})
.map_err(|_| {
// Decoding the transport frame is non-destructive and must
Expand Down
14 changes: 9 additions & 5 deletions src/codec/tcp/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,22 @@ pub fn decode(
}
})
.or_else(|err| {
let pdu_type = match decoder_type {
Request => "request",
Response => "response",
};
if drop_cnt + 1 >= MAX_FRAME_LEN {
#[cfg(feature = "log")]
log::error!(
"Giving up to decode frame after dropping {drop_cnt} byte(s): {:X?}",
&buf[0..drop_cnt]
);
return Err(err);
}
log::warn!("Failed to decode {pdu_type} frame: {err}");
#[cfg(feature = "log")]
log::warn!(
"Failed to decode {pdu_type} frame: {err}",
pdu_type = match decoder_type {
Request => "request",
Response => "response",
}
);
drop_cnt += 1;
retry = true;
Ok(None)
Expand Down
29 changes: 16 additions & 13 deletions src/codec/tcp/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ pub fn decode_request(buf: &[u8]) -> Result<Option<RequestAdu<'_>>> {
// Decoding of the PDU should are unlikely to fail due
// to transmission errors, because the frame's bytes
// have already been verified at the TCP level.
Request::try_from(pdu)
let request = Request::try_from(pdu)
.map(RequestPdu)
.map(|pdu| Some(RequestAdu { hdr, pdu }))
.inspect_err(|&err| {
// Unrecoverable error
log::error!("Failed to decode request PDU: {err}");
})
.map(|pdu| Some(RequestAdu { hdr, pdu }));
#[cfg(feature = "log")]
if let Err(error) = request {
// Unrecoverable error
log::error!("Failed to decode request PDU: {error}");
}
request
}

// Decode a TCP response
Expand All @@ -56,16 +58,17 @@ pub fn decode_response(buf: &[u8]) -> Result<Option<ResponseAdu<'_>>> {
// Decoding of the PDU should are unlikely to fail due
// to transmission errors, because the frame's bytes
// have already been verified at the TCP level.

Response::try_from(pdu)
let response = Response::try_from(pdu)
.map(Ok)
.or_else(|_| ExceptionResponse::try_from(pdu).map(Err))
.map(ResponsePdu)
.map(|pdu| Some(ResponseAdu { hdr, pdu }))
.inspect_err(|&err| {
// Unrecoverable error
log::error!("Failed to decode response PDU: {err}");
})
.map(|pdu| Some(ResponseAdu { hdr, pdu }));
#[cfg(feature = "log")]
if let Err(error) = response {
// Unrecoverable error
log::error!("Failed to decode response PDU: {error}");
}
response
})
.map_err(|_| {
// Decoding the transport frame is non-destructive and must
Expand Down
Loading