Struct fastobo::ast::Xref

pub struct Xref { /* fields omitted */ }

A database cross-reference definition.

Cross-references can be used in Def or Synonym clauses of entity frames to add sources for the provided definition or evidence to show the actual existence of a synonym. They can also be found in Xref clauses when the cross-reference is directly relevant to the annotated entity (e.g. when exporting an ontology from a knowledge-base to add an hyperlink to the original resource).

Methods

impl Xref

pub fn new<I>(id: I) -> Self where
    I: Into<Ident>, 

Create a new Xref from the given ID, without description.

pub fn with_desc<I, D>(id: I, desc: D) -> Self where
    I: Into<Ident>,
    D: Into<Option<QuotedString>>, 

Create a new Xref with the given ID and optional description.

pub fn id(&self) -> &Ident

Get a mutable reference to the identifier of the xref.

pub fn id_mut(&mut self) -> &mut Ident

Get a reference to the identifier of the xref.

pub fn description(&self) -> Option<&QuotedString>

Get a reference to the description of the xref, if any.

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

Get a mutable reference to the description of the xref, if any.

Trait Implementations

impl<'i> FromPair<'i> for Xref

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 Identified for Xref

fn as_id(&self) -> &Ident

Get a reference to the identifier of the entity.

fn as_id_mut(&mut self) -> &mut Ident

Get a mutable reference to the identifier of the entity.

impl Clone for Xref

fn clone(&self) -> Xref

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Xref

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

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Xref> for Xref

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

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

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

This method tests for !=.

impl Eq for Xref

impl Debug for Xref

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

Formats the value using the given formatter.

impl Display for Xref

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

Formats the value using the given formatter.

impl Hash for Xref

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 FromIterator<Xref> for XrefList

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Xref>, 

Creates a value from an iterator.

impl FromStr for Xref

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.