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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use itertools::Itertools;
use std::collections::HashMap;
use std::io::Read;
use std::path::PathBuf;
use walkdir::WalkDir;

pub(crate) fn filter_path(path: impl AsRef<std::path::Path>) -> bool {
    let path = path.as_ref();
    path.is_file()
        && path
            .file_name()
            .map(|file_name| {
                file_name
                    .to_str()
                    .map(|s| !s.starts_with('.'))
                    .unwrap_or(true)
            })
            .unwrap_or(false)
}

pub(crate) fn list_all_prefixes<'a>(
    resource_type: impl AsRef<str> + 'a,
    prefixes: impl IntoIterator<Item = impl AsRef<str> + 'a> + 'a,
) -> impl Iterator<Item = (String, PathBuf)> + 'a {
    prefixes.into_iter().map(move |prefix| {
        (
            prefix.as_ref().to_string(),
            [
                prefix.as_ref(),
                "share",
                "ament_index",
                "resource_index",
                resource_type.as_ref(),
            ]
            .iter()
            .collect(),
        )
    })
}

pub(crate) fn list_all_prefixes_of_resources_disjointly<'a>(
    resource_type: impl AsRef<str> + 'a,
    prefixes: impl IntoIterator<Item = impl AsRef<str> + 'a> + 'a,
) -> impl Iterator<Item = (String, String)> + 'a {
    list_all_prefixes(resource_type, prefixes).flat_map(|(prefix, path)| {
        WalkDir::new(path)
            .min_depth(1)
            .max_depth(1)
            .into_iter()
            .filter_entry(|e| filter_path(&e.path()))
            .filter_map(Result::ok)
            .map(move |entry| {
                (
                    entry.file_name().to_string_lossy().to_string(),
                    prefix.clone(),
                )
            })
    })
}

pub fn list_prefix_of_resources<'a>(
    resource_type: impl AsRef<str> + 'a,
    prefixes: impl IntoIterator<Item = impl AsRef<str> + 'a> + 'a,
) -> impl Iterator<Item = (String, String)> + 'a {
    list_all_prefixes_of_resources_disjointly(resource_type, prefixes)
        .unique_by(|(resource_name, _)| resource_name.clone())
}

pub fn list_all_prefixes_of_resources(
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> HashMap<String, Vec<String>> {
    list_all_prefixes_of_resources_disjointly(resource_type, prefixes).fold(
        HashMap::new(),
        |mut prefixes_of_resources, (resource_name, prefix)| {
            prefixes_of_resources
                .entry(resource_name)
                .or_default()
                .push(prefix);
            prefixes_of_resources
        },
    )
}

pub fn list_all_prefixes_of_resource<'a>(
    resource_name: impl AsRef<str> + 'a,
    resource_type: impl AsRef<str> + 'a,
    prefixes: impl IntoIterator<Item = impl AsRef<str> + 'a> + 'a,
) -> impl Iterator<Item = String> + 'a {
    list_all_prefixes_of_resources_disjointly(resource_type, prefixes)
        .filter(move |(found_name, _)| found_name == resource_name.as_ref())
        .map(|(_, prefix)| prefix)
}

pub fn get_resources_prefixes(
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> HashMap<String, Vec<String>> {
    list_all_prefixes_of_resources(resource_type, prefixes)
}

pub fn get_resource_prefix(
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> Option<String> {
    list_all_prefixes_of_resource(resource_name, resource_type, prefixes).next()
}

pub fn get_resource(
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> Option<(std::io::Result<Vec<u8>>, String)> {
    list_all_prefixes(resource_type, prefixes)
        .map(|(prefix, path)| (prefix, path.join(resource_name.as_ref())))
        .filter(|(_, path)| filter_path(path))
        .map(|(prefix, path)| {
            let mut buffer = vec![];
            (
                std::fs::File::open(path)
                    .and_then(|mut file| file.read_to_end(&mut buffer))
                    .map(|_| buffer),
                prefix,
            )
        })
        .next()
}

pub fn get_resources_prefix(
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> HashMap<String, String> {
    list_prefix_of_resources(resource_type, prefixes).collect()
}

pub fn find_resource(
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> Option<String> {
    list_all_prefixes(resource_type, prefixes)
        .map(|(prefix, path)| (prefix, path.join(resource_name.as_ref())))
        .filter(|(_, path)| filter_path(path))
        .map(|(prefix, _)| prefix)
        .next()
}

pub fn has_resource(
    resource_name: impl AsRef<str>,
    resource_type: impl AsRef<str>,
    prefixes: impl IntoIterator<Item = impl AsRef<str>>,
) -> bool {
    find_resource(resource_name, resource_type, prefixes).is_some()
}