Skip to content

Commit 5ba2dad

Browse files
committed
added example to RclrsError
1 parent b40f96a commit 5ba2dad

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

rclrs/src/error.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ use crate::{rcl_bindings::*, DeclarationError};
1010
#[derive(Debug, PartialEq, Eq)]
1111
pub enum RclrsError {
1212
/// An error originating in the `rcl` layer.
13+
/// Example:
14+
/// ```rust
15+
/// let error: RclrsError = RclrsError::RclError { code: RclReturnCode::Timeout, msg: None };
16+
/// match &error {
17+
/// RclrsError::RclError { msg, .. } => assert_eq!(msg, &None),
18+
/// _ => panic!("Unexpected error variant"),
19+
/// }
20+
/// ```
1321
RclError {
1422
/// The error code.
1523
code: RclReturnCode,

0 commit comments

Comments
 (0)