Enum robot_description_builder::identifiers::GroupIDErrorKind

pub enum GroupIDErrorKind {
    ContainsOpen,
    ContainsClose,
    Empty,
}

Enum to store the various types of errors that can cause invalidation of a GroupID.

Important

When a validity check fails the error gets returned immediately, meaning that if it fails for multiple reasons only the first one is provided. This is the order the GroupID validity checks get performed:

1. Check for DELIMITER_OPEN_GROUPID (ContainsOpen)
2. Check for DELIMITER_CLOSE_GROUPID (ContainsClose)
3. Check if non-empty (Empty)

Example

if let Err(e) = GroupID::is_valid_group_id(&"[[ThisIsInvalid]]") {
    println!("Invalid GroupID: {:?}", e.kind());
}

Variants

ContainsOpen

GroupID being checked contains an unescaped opening GroupID delimiter.

This variant will be constructed when the GroupID being checked contains DELIMITER_OPEN_GROUPID.

ContainsClose

GroupID being checked contains an unescaped closing GroupID delimiter.

This variant will be constructed when the GroupID being checked contains DELIMITER_CLOSE_GROUPID.

Empty

GroupID being checked is empty.

This variant will be constructed when checking the GroupID validity of an empty string.

Trait Implementations

impl Clone for GroupIDErrorKind

fn clone(&self) -> GroupIDErrorKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupIDErrorKind

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

Formats the value using the given formatter.

impl PartialEq<GroupIDErrorKind> for GroupIDErrorKind

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

impl StructuralEq for GroupIDErrorKind

impl StructuralPartialEq for GroupIDErrorKind