rclrust 0.0.2

ROS2 client written in Rust
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use std::sync::Arc;

use anyhow::Result;

use crate::context::Context;
use crate::init_options::InitOptions;

/// Initialize rclrust context
///
/// # Examples
///
/// ```
/// let ctx = rclrust::init().unwrap();
/// assert!(ctx.is_valid());
/// ```
pub fn init() -> Result<Arc<Context>> {
    init_with_options(InitOptions::new()?)
}

/// Initialize rclrust context
///
/// # Examples
///
/// ```
/// use rclrust::InitOptions;
///
/// let init_options = InitOptions::new().unwrap();
/// let ctx = rclrust::init_with_options(init_options).unwrap();
/// assert!(ctx.is_valid());
/// ```
pub fn init_with_options(init_options: InitOptions) -> Result<Arc<Context>> {
    Context::new(std::env::args().collect::<Vec<_>>(), init_options)
}

/// Check rclrust's status.
pub fn ok(ctx: Arc<Context>) -> bool {
    ctx.is_valid()
}

/// Shutdown rclrust context
pub fn shutdown(ctx: Arc<Context>, reason: &str) -> Result<()> {
    ctx.shutdown(reason)
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn rclrust_init() -> Result<()> {
        let ctx = init()?;
        assert!(ok(ctx));

        Ok(())
    }
}