Crate ament_rs

This crate is a client for ament which is a system for cataloging and referencing resources distributed by software packages used by ROS2.

Examples

use ament_rs::*;
println!("{:#?}", Ament::new()?.get_packages_prefixes());

This snippet will print a list of packages with the prefixes they were found in, depending of the value of the AMENT_PREFIX_PATH environment variable on your system.

{
    "ros_core": [
        "/opt/ros/crystal",
        "/opt/ros/bouncy",
    ],
    "console_bridge_vendor": [
        "/opt/ros/dashing",
        "/opt/ros/crystal",
    ],
    "ament_cmake_export_interfaces": [
        "/opt/ros/dashing",
        "/opt/ros/crystal",
        "/opt/ros/bouncy",
    ],
}

Re-exports

pub use ament::Ament;

Modules

ament

Defines the Ament struct storing a list of prefixes in which resources will be searched.

packages

Contains functions to retrieve packages registered as ament resources.

resources

search_paths

Contains functions to retrieve ament resource index prefixes.

Constants

AMENT_PREFIX_PATH_ENV_VAR

This constant defines the name of the environment variable containing the list of ament resource index prefixes, which is AMENT_PREFIX_PATH