Struct robot_description_builder::identifiers::GroupIDError

pub struct GroupIDError { /* private fields */ }

An error which can be returned when checking for a GroupID’s validity.

This error is used as an error type for functions which check for GroupID validity such as GroupID::is_valid_group_id/

TODO: Potential causes ?

Example

if let Err(e) = GroupID::is_valid_group_id(&"[[no]]") {
    println!("Invalid GroupID: {e}");
}

Implementations

impl GroupIDError

pub fn group_id(&self) -> &String

Returns a reference to a cloned String of the GroupID, which caused the error.

pub fn kind(&self) -> &GroupIDErrorKind

Outputs the detailed cause of invalidation of the GroupID.

Trait Implementations

impl Clone for GroupIDError

fn clone(&self) -> GroupIDError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupIDError

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

Formats the value using the given formatter.

impl Display for GroupIDError

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

Formats the value using the given formatter.

impl Error for GroupIDError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl PartialEq<GroupIDError> for GroupIDError

fn eq(&self, other: &GroupIDError) -> 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 GroupIDError

impl StructuralEq for GroupIDError

impl StructuralPartialEq for GroupIDError