Struct ros_message::MessagePath

pub struct MessagePath { /* private fields */ }

Path to a ROS message with naming conventions tested.

Implementations

impl MessagePath

pub fn new(package: impl Into<String>, name: impl Into<String>) -> Result<Self>

Create full message path, with naming rules checked

Naming rules are based on REP 144.

Errors

An error will be returned if naming conventions are not met.

Examples

let message_path = MessagePath::new("foo", "Bar")?;

assert_eq!(message_path.package(), "foo");
assert_eq!(message_path.name(), "Bar");

assert!(MessagePath::new("0foo", "Bar").is_err());

pub fn peer(&self, name: impl Into<String>) -> Self

Create a new message path inside the same package.

Prevents the need for constant error checking of package names.

Examples

let message_path = MessagePath::new("foo", "Bar")?.peer("Baz");

assert_eq!(message_path.package(), "foo");
assert_eq!(message_path.name(), "Baz");

pub fn package(&self) -> &str

Package that the message is located in.

pub fn name(&self) -> &str

Name of the message inside the package.

Trait Implementations

impl Clone for MessagePath

fn clone(&self) -> MessagePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessagePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessagePath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MessagePath

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

Formats the value using the given formatter.

impl From<MessagePath> for String

fn from(src: MessagePath) -> Self

Converts to this type from the input type.

impl Hash for MessagePath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MessagePath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessagePath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for MessagePath

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for MessagePath

impl StructuralPartialEq for MessagePath