Skip to content

Commit 4c7c909

Browse files
committed
Fix docs to compile
1 parent 75ae06a commit 4c7c909

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

rclrs/src/context.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use crate::rcl_bindings::*;
2-
use crate::{Node, RclrsError, ToResult};
2+
use crate::{Node, NodeBuilder, RclrsError, ToResult};
33

44
use std::ffi::CString;
55
use std::os::raw::c_char;
@@ -108,11 +108,11 @@ impl Context {
108108
///
109109
/// # Example
110110
/// ```
111-
/// # use rclrs::{Context, RclReturnCode};
111+
/// # use rclrs::{Context, RclrsError};
112112
/// let ctx = Context::new([])?;
113113
/// let node = ctx.create_node("my_node");
114114
/// assert!(node.is_ok());
115-
/// # Ok::<(), RclReturnCode>(())
115+
/// # Ok::<(), RclrsError>(())
116116
/// ```
117117
pub fn create_node(&self, node_name: &str) -> Result<Node, RclrsError> {
118118
NodeBuilder::new(node_name, self).build()
@@ -128,12 +128,12 @@ impl Context {
128128
///
129129
/// # Example
130130
/// ```
131-
/// # use rclrs::{Context, RclReturnCode};
131+
/// # use rclrs::{Context, RclrsError};
132132
/// let context = Context::new([])?;
133133
/// let node_builder = context.create_node_builder("foo_node");
134134
/// let node = node_builder.build()?;
135135
/// assert_eq!(node.name(), "foo_node");
136-
/// # Ok::<(), RclReturnCode>(())
136+
/// # Ok::<(), RclrsError>(())
137137
/// ```
138138
pub fn create_node_builder(&self, node_name: &str) -> NodeBuilder {
139139
NodeBuilder::new(node_name, self)

rclrs/src/node/mod.rs

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ pub struct Node {
4949
///
5050
/// # Example
5151
/// ```
52-
/// # use rclrs::{Context, Node, NodeBuilder, RclReturnCode};
52+
/// # use rclrs::{Context, Node, NodeBuilder, RclrsError};
5353
/// let context = Context::new([])?;
5454
/// let node = NodeBuilder::new("foo_node", &context).namespace("/bar").build()?;
5555
/// assert_eq!(node.name(), "foo_node");
5656
/// assert_eq!(node.namespace(), "/bar");
57-
/// # Ok::<(), RclReturnCode>(())
57+
/// # Ok::<(), RclrsError>(())
5858
/// ```
5959
pub struct NodeBuilder {
6060
context: Arc<Mutex<rcl_context_t>>,
@@ -226,14 +226,14 @@ impl Node {
226226
///
227227
/// # Example
228228
/// ```
229-
/// # use rclrs::{Context, RclReturnCode};
229+
/// # use rclrs::{Context, RclrsError};
230230
/// // set default ROS domain ID to 10 here
231231
/// std::env::set_var("ROS_DOMAIN_ID", "10");
232232
/// let context = Context::new([])?;
233233
/// let node = context.create_node("domain_id_node")?;
234234
/// let domain_id = node.domain_id();
235235
/// assert_eq!(domain_id, 10);
236-
/// # Ok::<(), RclReturnCode>(())
236+
/// # Ok::<(), RclrsError>(())
237237
/// ```
238238
// TODO: If node option is supported,
239239
// add description about this function is for getting actual domain_id
@@ -274,18 +274,18 @@ impl NodeBuilder {
274274
///
275275
/// # Example
276276
/// ```
277-
/// # use rclrs::{Context, Node, NodeBuilder, RclReturnCode, NodeErrorCode};
277+
/// # use rclrs::{Context, Node, NodeBuilder, RclrsError, RclReturnCode, NodeErrorCode};
278278
/// let context = Context::new([])?;
279279
/// let builder = NodeBuilder::new("foo_node", &context);
280280
/// let node = builder.build()?;
281281
/// assert_eq!(node.name(), "foo_node");
282282
/// // invalid node name
283283
/// let builder = NodeBuilder::new("123abc", &context);
284284
/// assert_eq!(
285-
/// builder.build(),
286-
/// Err(RclReturnCode::NodeError(NodeErrorCode::NodeInvalidName))
285+
/// builder.build().unwrap_err().code,
286+
/// RclReturnCode::NodeError(NodeErrorCode::NodeInvalidName)
287287
/// );
288-
/// # Ok::<(), RclReturnCode>(())
288+
/// # Ok::<(), RclrsError>(())
289289
/// ```
290290
///
291291
/// [1]: NodeBuilder::build
@@ -323,18 +323,18 @@ impl NodeBuilder {
323323
///
324324
/// # Example
325325
/// ```
326-
/// # use rclrs::{Context, Node, NodeBuilder, RclReturnCode, NodeErrorCode};
326+
/// # use rclrs::{Context, Node, NodeBuilder, RclrsError, RclReturnCode, NodeErrorCode};
327327
/// let context = Context::new([])?;
328328
/// let builder = NodeBuilder::new("node_name", &context);
329329
/// let node = builder.namespace("/foo/bar").build()?;
330330
/// assert_eq!(node.fully_qualified_name(), "/foo/bar/node_name");
331331
/// // invalid namespace
332332
/// let builder = NodeBuilder::new("node_name", &context);
333333
/// assert_eq!(
334-
/// builder.namespace("123abc").build(),
335-
/// Err(RclReturnCode::NodeError(NodeErrorCode::NodeInvalidNamespace))
334+
/// builder.namespace("123abc").build().unwrap_err().code,
335+
/// RclReturnCode::NodeError(NodeErrorCode::NodeInvalidNamespace)
336336
/// );
337-
/// # Ok::<(), RclReturnCode>(())
337+
/// # Ok::<(), RclrsError>(())
338338
/// ```
339339
pub fn namespace(mut self, namespace: &str) -> Self {
340340
self.namespace = namespace.to_string();
@@ -345,11 +345,11 @@ impl NodeBuilder {
345345
///
346346
/// Node name and namespace validation is performed in this method.
347347
/// If invalid name and/or namespace are specified to builder,
348-
/// this method will return RclReturnCode as error.
348+
/// this method will return RclRsError as error.
349349
///
350350
/// # Example
351351
/// ```
352-
/// # use rclrs::{Context, Node, NodeBuilder, RclReturnCode, NodeErrorCode};
352+
/// # use rclrs::{Context, Node, NodeBuilder, RclrsError, RclReturnCode, NodeErrorCode};
353353
/// let context = Context::new([])?;
354354
///
355355
/// let builder = NodeBuilder::new("node_name", &context);
@@ -359,19 +359,19 @@ impl NodeBuilder {
359359
/// let builder = NodeBuilder::new("123abc", &context);
360360
/// let result = builder.namespace("/foo/bar").build();
361361
/// assert_eq!(
362-
/// result,
363-
/// Err(RclReturnCode::NodeError(NodeErrorCode::NodeInvalidName))
362+
/// result.unwrap_err().code,
363+
/// RclReturnCode::NodeError(NodeErrorCode::NodeInvalidName)
364364
/// );
365365
/// // invalid namespace
366366
/// let builder = NodeBuilder::new("node_name", &context);
367367
/// let result = builder.namespace("123abc").build();
368368
/// assert_eq!(
369-
/// result,
370-
/// Err(RclReturnCode::NodeError(NodeErrorCode::NodeInvalidNamespace))
369+
/// result.unwrap_err().code,
370+
/// RclReturnCode::NodeError(NodeErrorCode::NodeInvalidNamespace)
371371
/// );
372-
/// # Ok::<(), RclReturnCode>(())
372+
/// # Ok::<(), RclrsError>(())
373373
/// ```
374-
pub fn build(&self) -> Result<Node, RclReturnCode> {
374+
pub fn build(&self) -> Result<Node, RclrsError> {
375375
let node_name = CString::new(self.name.as_str()).unwrap();
376376
let node_namespace = CString::new(self.namespace.as_str()).unwrap();
377377

0 commit comments

Comments
 (0)