Struct fastobo::ast::Synonym

pub struct Synonym { /* fields omitted */ }

A synonym, denoting an alternative name for the embedding entity.

Methods

impl Synonym

pub fn new<D>(desc: D, scope: SynonymScope) -> Self where
    D: Into<QuotedString>, 

Create a Synonym with the given description and scope.

pub fn with_type<D, T>(desc: D, scope: SynonymScope, ty: T) -> Self where
    D: Into<QuotedString>,
    T: Into<Option<SynonymTypeIdent>>, 

Create a Synonym with the given description, scope, and type.

pub fn with_xrefs<D, L>(desc: D, scope: SynonymScope, xrefs: L) -> Self where
    D: Into<QuotedString>,
    L: Into<XrefList>, 

Create a Synonym with the given description, scope, and xrefs.

pub fn with_type_and_xrefs<D, T, L>(
    desc: D,
    scope: SynonymScope,
    ty: T,
    xrefs: L
) -> Self where
    D: Into<QuotedString>,
    T: Into<Option<SynonymTypeIdent>>,
    L: Into<XrefList>, 

Create a Synonym with the given description, scope, type, and xrefs.

impl Synonym

pub fn description(&self) -> &QuotedString

Get a reference to the description of the Synonym.

pub fn description_mut(&mut self) -> &mut QuotedString

Get a mutable reference to the description of the Synonym.

pub fn scope(&self) -> &SynonymScope

Get a reference to the scope of the Synonym.

pub fn scope_mut(&mut self) -> &mut SynonymScope

Get a mutable reference to the scope of the Synonym.

pub fn ty(&self) -> Option<&SynonymTypeIdent>

Get a reference to the type of the Synonym, if any.

pub fn ty_mut(&mut self) -> Option<&mut SynonymTypeIdent>

Get a mutable reference to the type of the Synonym, if any.

pub fn xrefs(&self) -> &XrefList

Get a reference to the xrefs of the Synonym.

pub fn xrefs_mut(&mut self) -> &mut XrefList

Get a mutable reference to the xrefs of the Synonym.

Trait Implementations

impl<'i> FromPair<'i> for Synonym

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 Clone for Synonym

fn clone(&self) -> Synonym

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Synonym

fn cmp(&self, other: &Synonym) -> 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 PartialOrd<Synonym> for Synonym

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Synonym> for Synonym

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

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

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

This method tests for !=.

impl Eq for Synonym

impl Debug for Synonym

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

Formats the value using the given formatter.

impl Display for Synonym

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

Formats the value using the given formatter.

impl Hash for Synonym

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 Synonym

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.