Struct ament_rs::ament::Ament

pub struct Ament {
    pub prefixes: Vec<String>,
}

Stores a list of prefixes in which resources will be searched.

Fields

prefixes: Vec<String>

The list of prefixes in which resources will be searched.

Methods

impl Ament

pub fn new() -> Result<Self, VarError>

Constructs a new Ament struct with prefixes read from 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 from_var(env_var: impl AsRef<str>) -> Result<Self, VarError>

Constructs a new Ament struct with prefixes read from the given environment variable.

Errors

A std::env::VarError is returned if the given environment variable is not set.

pub fn get_packages_prefix(&self) -> HashMap<String, String>

Returns a map containing packages name for key and the first prefix in which each package was found for value.

pub fn get_packages_prefixes(&self) -> HashMap<String, Vec<String>>

Returns a map containing packages name for key and the list of prefixes in which each package was found for value.

pub fn get_package_share_directory(
    &self,
    package_name: impl AsRef<str>
) -> Option<PathBuf>

Returns the share directory of the package or None is the package was not found.

pub fn find_package(&self, package_name: impl AsRef<str>) -> Option<String>

Returns the prefix in which the given package has been found or None if the package has not been found.

pub fn has_package(&self, package_name: impl AsRef<str>) -> bool

Returns true if the given package exists in the ament resource index, returns false otherwise.

pub fn get_resource(
    &self,
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>
) -> Option<(Result<Vec<u8>>, String)>

Returns the content of the resource if the given resource exists in the ament resource index, or None if the resource was not found.

pub fn get_resources_prefix(
    &self,
    resource_type: impl AsRef<str>
) -> HashMap<String, String>

Returns a map containing resources name for key and the first prefix in which each resource was found for value.

pub fn get_resources_prefixes(
    &self,
    resource_type: impl AsRef<str>
) -> HashMap<String, Vec<String>>

Returns a map containing resources name for key and the list of prefixes in which each resource was found for value.

pub fn find_resource(
    &self,
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>
) -> Option<String>

Returns the prefix in which the given resource was found or None if the resource was not found.

pub fn has_resource(
    &self,
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>
) -> bool

Returns true if the given resource exists in the ament resource index, returns false otherwise.

Trait Implementations

impl PartialEq<Ament> for Ament

fn eq(&self, other: &Ament) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Ament) -> bool

This method tests for !=.

impl Clone for Ament

fn clone(&self) -> Ament

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ament

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.