Enum fastobo::ast::HeaderClause

pub enum HeaderClause {
    FormatVersion(UnquotedString),
    DataVersion(UnquotedString),
    Date(NaiveDateTime),
    SavedBy(UnquotedString),
    AutoGeneratedBy(UnquotedString),
    Import(Import),
    Subsetdef(SubsetIdent, QuotedString),
    SynonymTypedef(SynonymTypeIdent, QuotedString, Option<SynonymScope>),
    DefaultNamespace(NamespaceIdent),
    NamespaceIdRule(UnquotedString),
    Idspace(IdentPrefix, Url, Option<QuotedString>),
    TreatXrefsAsEquivalent(IdentPrefix),
    TreatXrefsAsGenusDifferentia(IdentPrefix, RelationIdent, ClassIdent),
    TreatXrefsAsReverseGenusDifferentia(IdentPrefix, RelationIdent, ClassIdent),
    TreatXrefsAsRelationship(IdentPrefix, RelationIdent),
    TreatXrefsAsIsA(IdentPrefix),
    TreatXrefsAsHasSubclass(IdentPrefix),
    PropertyValue(PropertyValue),
    Remark(UnquotedString),
    Ontology(UnquotedString),
    OwlAxioms(UnquotedString),
    Unreserved(UnquotedString, UnquotedString),
}

A clause appearing in a header frame.

Header clauses are used to add metadata to OBO documents. They are all optional, but every document should at least contain a FormatVersion clause, to help with interoperability and to make sure the semantics of the right OBO specification are in use.

Comparison

HeaderClause implements PartialOrd following the semantics of the OBO specification: clauses will compare based on their serialization order rather than on their alphabetic order; clauses of the same kind will be ranked in the alphabetic order.

Variants

FormatVersion(UnquotedString)DataVersion(UnquotedString)Date(NaiveDateTime)SavedBy(UnquotedString)AutoGeneratedBy(UnquotedString)Import(Import)Subsetdef(SubsetIdent, QuotedString)SynonymTypedef(SynonymTypeIdent, QuotedString, Option<SynonymScope>)DefaultNamespace(NamespaceIdent)NamespaceIdRule(UnquotedString)Idspace(IdentPrefix, Url, Option<QuotedString>)TreatXrefsAsEquivalent(IdentPrefix)TreatXrefsAsGenusDifferentia(IdentPrefix, RelationIdent, ClassIdent)TreatXrefsAsReverseGenusDifferentia(IdentPrefix, RelationIdent, ClassIdent)TreatXrefsAsRelationship(IdentPrefix, RelationIdent)TreatXrefsAsIsA(IdentPrefix)TreatXrefsAsHasSubclass(IdentPrefix)PropertyValue(PropertyValue)Remark(UnquotedString)Ontology(UnquotedString)OwlAxioms(UnquotedString)Unreserved(UnquotedString, UnquotedString)

Trait Implementations

impl<'i> FromPair<'i> for HeaderClause

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 OboClause for HeaderClause

fn tag(&self) -> &str

Get the raw string corresponding to the tag of a clause.

fn cardinality(&self) -> Cardinality

Get the cardinality expected for a clause variant.

impl Eq for HeaderClause

impl Ord for HeaderClause

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

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

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

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

This method tests for !=.

impl Clone for HeaderClause

fn clone(&self) -> HeaderClause

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<HeaderClause> for HeaderClause

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

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

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

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

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

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

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

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

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

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

impl From<HeaderClause> for HeaderFrame

fn from(clause: HeaderClause) -> Self

Performs the conversion.

impl Debug for HeaderClause

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

Formats the value using the given formatter.

impl Display for HeaderClause

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

Formats the value using the given formatter.

impl Hash for HeaderClause

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<HeaderClause> for HeaderFrame

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

Creates a value from an iterator.

impl FromStr for HeaderClause

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.