Struct ros2_client::Name

pub struct Name { /* private fields */ }

Names for Topics, Services

See Names for ROS 1. and topic and Service name mapping to DDS in ROS 2 documentation.

Implementations

impl Name

pub fn new(namespace: &str, base_name: &str) -> Result<Name, NameError>

Construct a new Name from namespace and base name.

If the namespace begins with a slash (/) character, the Name will be absolute, otherwise it will be relative. The namespace may consist of several components, separated by slashes. Tha namespace must not end in a slash, unless the namespace is just "/".

Do not put slashes in the base_name. Base name is not allowed to be empty, but the namespace may be empty.

Tilde or brace substitutions are not (yet) supported.

pub fn parse(full_name: &str) -> Result<Name, NameError>

Construct a new Name from slash-separated namespace and base name.

e.g. myspace/some_name

pub fn to_dds_name( &self, kind_prefix: &str, node: &NodeName, suffix: &str ) -> String

pub fn is_absolute(&self) -> bool

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Display for Name

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

Formats the value using the given formatter.

impl PartialEq for Name

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

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

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

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

impl Eq for Name

impl StructuralEq for Name

impl StructuralPartialEq for Name