Files
adler32
aho_corasick
alga
approx
ascii
atty
backtrace
backtrace_sys
base64
bitflags
blas_src
block_buffer
block_padding
brotli2
brotli_sys
buf_redux
byte_tools
byteorder
cauchy
cblas_sys
cfg_if
chrono
chunked_transfer
colored
crc32fast
crossbeam
crossbeam_channel
crossbeam_deque
crossbeam_epoch
crossbeam_queue
crossbeam_utils
ctrlc
deflate
digest
dirs
error_chain
filetime
futures
generic_array
getrandom
gzip_header
hex
httparse
hyper
idna
itoa
language_tags
lapack_src
lapacke
lapacke_sys
lazy_static
libc
libm
linked_hash_map
log
matches
matrixmultiply
maybe_uninit
md5
memchr
memoffset
mime
mime_guess
multipart
nalgebra
base
geometry
linalg
ndarray
ndarray_linalg
net2
netlib_src
nix
num_complex
num_cpus
num_integer
num_rational
num_traits
opaque_debug
percent_encoding
phf
phf_shared
ppv_lite86
proc_macro2
quick_error
quote
rand
rand_chacha
rand_core
rand_distr
rawpointer
regex
regex_syntax
remove_dir_all
rosrust
rosrust_codegen
rosrust_msg
rouille
rustc_demangle
rustros_tf
ryu
safemem
scopeguard
serde
serde_bytes
serde_derive
serde_json
serde_xml_rs
sha1
siphasher
smallvec
syn
tempdir
term
thread_local
threadpool
time
tiny_http
traitobject
twoway
typeable
typenum
ucd_util
unicase
unicode_bidi
unicode_normalization
unicode_xid
url
utf8_ranges
void
xml
xml_rpc
yaml_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
 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
use crate::error::{Error, ErrorKind, Result};
use error_chain::bail;
use lazy_static::lazy_static;
use regex::Regex;
use std::convert::TryFrom;
use std::fmt::{Display, Formatter};
use std::hash::Hash;

#[derive(Clone, Debug, Hash, PartialEq, Eq)]
pub struct MessagePath {
    pub package: String,
    pub name: String,
}

impl MessagePath {
    pub fn new(package: impl Into<String>, name: impl Into<String>) -> Self {
        Self {
            package: package.into(),
            name: name.into(),
        }
    }

    fn from_combined(input: &str) -> Result<Self> {
        let mut parts = input.splitn(2, '/');
        let package = match parts.next() {
            Some(v) => v,
            None => bail!("Package string constains no parts: {}", input),
        };
        let name = match parts.next() {
            Some(v) => v,
            None => bail!(
                "Package string needs to be in package/name format: {}",
                input
            ),
        };
        let output = Self::new(package, name);
        output.validate()?;
        Ok(output)
    }

    /// Perform package name validity checks
    ///
    /// Based on [REP 144](https://www.ros.org/reps/rep-0144.html).
    fn has_valid_package_name(&self) -> bool {
        RE_PACKAGE_CORRECT_CHAR_SET_AND_LENGTH.is_match(&self.package)
            && !RE_PACKAGE_CONSECUTIVE_UNDERSCORE.is_match(&self.package)
    }

    pub fn validate(&self) -> Result<()> {
        if !self.has_valid_package_name() {
            bail!(ErrorKind::PackageNameInvalid(self.package.clone()));
        }
        Ok(())
    }
}

impl Display for MessagePath {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}/{}", self.package, self.name)
    }
}

impl<'a> TryFrom<&'a str> for MessagePath {
    type Error = Error;

    fn try_from(value: &'a str) -> Result<Self> {
        Self::from_combined(value)
    }
}

lazy_static! {
    static ref RE_PACKAGE_CORRECT_CHAR_SET_AND_LENGTH: Regex =
        Regex::new("^[a-z][a-z0-9_]+$").unwrap();
    static ref RE_PACKAGE_CONSECUTIVE_UNDERSCORE: Regex = Regex::new("__").unwrap();
}

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

    fn is_valid_package_name(package: &str) -> bool {
        MessagePath::new(package, "anything").has_valid_package_name()
    }

    #[test]
    fn package_names_must_be_at_least_two_characters() {
        assert!(is_valid_package_name("foo"));
        assert!(is_valid_package_name("fo"));
        assert!(!is_valid_package_name("f"));
    }

    #[test]
    fn package_names_must_start_with_lowercase_alphabetic() {
        assert!(is_valid_package_name("foo_123"));
        assert!(!is_valid_package_name("Foo_123"));
        assert!(!is_valid_package_name("1oo_123"));
        assert!(!is_valid_package_name("_oo_123"));
    }

    #[test]
    fn package_names_must_not_contain_uppercase_anywhere() {
        assert!(is_valid_package_name("foo_123"));
        assert!(!is_valid_package_name("foO_123"));
    }

    #[test]
    fn package_names_are_limited_to_lowercase_alphanumeric_and_underscore() {
        assert!(is_valid_package_name("foo_123"));
        assert!(!is_valid_package_name("foO_123"));
        assert!(!is_valid_package_name("foo-123"));
    }

    #[test]
    fn package_names_must_not_contain_multiple_underscores_in_a_row() {
        assert!(is_valid_package_name("foo_123_"));
        assert!(is_valid_package_name("f_o_o_1_2_3_"));
        assert!(!is_valid_package_name("foo__123_"));
        assert!(!is_valid_package_name("foo___123_"));
    }
}