Struct fastobo::ast::IdentPrefix

pub struct IdentPrefix { /* fields omitted */ }

An identifier prefix, either canonical or non-canonical.

• A canonical ID prefix only contains alphabetic characters ([a-zA-Z]) followed by either an underscore or other alphabetic characters.
• A non-canonical ID prefix can contain any character besides :.

Example

let id = PrefixedIdent::from_str("GO:0046154").unwrap();
assert!(id.prefix().is_canonical());
assert_eq!(id.prefix(), "GO");

Methods

impl IdentPrefix

pub fn new<S>(prefix: S) -> Self where
    S: Into<String>, 

Create a new identifier prefix.

pub fn is_canonical(&self) -> bool

Check if the identifier prefix is canonical or not.

Example

assert!(IdentPrefix::new(String::from("GO")).is_canonical());

pub unsafe fn new_unchecked(s: String, canonical: bool) -> Self

Create a new IdPrefix without checking if it is canonical or not.

This is unsafe because the canonical flag will be used to determine if the prefix needs escaping. If not set right, the syntax of the produced serialization could be invalid.

pub fn as_str(&self) -> &str

Get the prefix as a string slice.

pub fn into_string(self) -> String

Extract the unescaped prefix as a String.

Trait Implementations

impl<'i> FromPair<'i> for IdentPrefix

const RULE: Rule

unsafe fn from_pair_unchecked(pair: Pair<'i, Rule>) -> Result<Self, SyntaxError>

Create a new instance from a Pair without checking the rule.

fn from_pair(pair: Pair<'i, Rule>) -> Result<Self, SyntaxError>

Create a new instance from a Pair.

impl<'a> Share<'a, IdPrefix<'a>> for IdentPrefix

fn share(&'a self) -> IdPrefix<'a>

impl Eq for IdentPrefix

impl Ord for IdentPrefix

fn cmp(&self, other: &IdentPrefix) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<IdentPrefix> for IdentPrefix

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<str> for IdentPrefix

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

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

#[must_use]

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

This method tests for !=.

impl Clone for IdentPrefix

fn clone(&self) -> IdentPrefix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<IdentPrefix> for IdentPrefix

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl AsRef<str> for IdentPrefix

fn as_ref(&self) -> &str

Performs the conversion.

impl From<IdentPrefix> for String

fn from(prefix: IdentPrefix) -> String

Performs the conversion.

impl From<String> for IdentPrefix

fn from(s: String) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for IdentPrefix

fn from(s: &str) -> Self

Performs the conversion.

impl Debug for IdentPrefix

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

Formats the value using the given formatter.

impl Display for IdentPrefix

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl Hash for IdentPrefix

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, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for IdentPrefix

type Err = SyntaxError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.