Skip to content

Commit 1ee051a

Browse files
committed
Fix docs, Replace err types and Delete some methods
1 parent fc04e9a commit 1ee051a

File tree

2 files changed

+137
-114
lines changed

2 files changed

+137
-114
lines changed

rclrs/src/context.rs

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

44
use std::ffi::CString;
55
use std::os::raw::c_char;
@@ -58,7 +58,7 @@ impl Context {
5858
///
5959
/// # Panics
6060
/// When there is an interior null byte in any of the args.
61-
pub fn new(args: impl IntoIterator<Item = String>) -> Result<Self, RclReturnCode> {
61+
pub fn new(args: impl IntoIterator<Item = String>) -> Result<Self, RclrsError> {
6262
// SAFETY: Getting a zero-initialized value is always safe
6363
let mut rcl_context = unsafe { rcl_get_zero_initialized_context() };
6464
let cstring_args: Vec<CString> = args
@@ -108,41 +108,16 @@ 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
/// ```
117-
pub fn create_node(&self, node_name: &str) -> Result<Node, RclReturnCode> {
117+
pub fn create_node(&self, node_name: &str) -> Result<Node, RclrsError> {
118118
NodeBuilder::new(node_name, self).build()
119119
}
120120

121-
/// Creates a new node in a namespace.
122-
///
123-
/// Convenience function equivalent to [`Node::new_with_namespace`][1].
124-
/// Please see that function's documentation.
125-
///
126-
/// [1]: crate::Node::new_with_namespace
127-
///
128-
/// # Example
129-
/// ```
130-
/// # use rclrs::{Context, RclReturnCode};
131-
/// let ctx = Context::new([])?;
132-
/// let node = ctx.create_node_with_namespace("/my/nested/namespace", "my_node");
133-
/// assert!(node.is_ok());
134-
/// # Ok::<(), RclReturnCode>(())
135-
/// ```
136-
pub fn create_node_with_namespace(
137-
&self,
138-
node_namespace: &str,
139-
node_name: &str,
140-
) -> Result<Node, RclReturnCode> {
141-
NodeBuilder::new(node_name, self)
142-
.namespace(node_namespace)
143-
.build()
144-
}
145-
146121
/// Creates a [`NodeBuilder`][1].
147122
///
148123
/// Convenience function equivalent to [`NodeBuilder::new`][2].
@@ -153,12 +128,12 @@ impl Context {
153128
///
154129
/// # Example
155130
/// ```
156-
/// # use rclrs::{Context, RclReturnCode};
131+
/// # use rclrs::{Context, RclrsError};
157132
/// let context = Context::new([])?;
158133
/// let node_builder = context.create_node_builder("foo_node");
159134
/// let node = node_builder.build()?;
160135
/// assert_eq!(node.name(), "foo_node");
161-
/// # Ok::<(), RclReturnCode>(())
136+
/// # Ok::<(), RclrsError>(())
162137
/// ```
163138
pub fn create_node_builder(&self, node_name: &str) -> NodeBuilder {
164139
NodeBuilder::new(node_name, self)

0 commit comments

Comments
 (0)