ament_rs 0.3.0

This crate is a client for ament which is a system for cataloging and referencing resources distributed by software packages used by ROS2.
Documentation 
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

//! Contains functions to retrieve ament resource index prefixes.
//!
//! Prefixes are system paths separated by a colon.

use crate::AMENT_PREFIX_PATH_ENV_VAR;

/// Returns the list of prefixes defined in the `AMENT_PREFIX_PATH` environment variable.
///
/// # Errors
///
/// A `std::env::VarError` is returned if the `AMENT_PREFIX_PATH` environment variable is not set.
pub fn get_search_paths() -> Result<Vec<String>, std::env::VarError> {
    get_search_paths_from_var(AMENT_PREFIX_PATH_ENV_VAR)
}

/// Returns the list of prefixes defined in the given environment variable.
///
/// # Errors
///
/// A `std::env::VarError` is returned if the given environment variable is not set.
pub fn get_search_paths_from_var(
    env_var: impl AsRef<str>,
) -> Result<Vec<String>, std::env::VarError> {
    Ok(get_search_paths_from(std::env::var(env_var.as_ref())?))
}

/// Returns the list of prefixes defined in the given string.
pub fn get_search_paths_from(prefixes_list: impl AsRef<str>) -> Vec<String> {
    prefixes_list
        .as_ref()
        .split(':')
        .map(str::to_string)
        .collect()
}