Enum EntityFrame

pub enum EntityFrame {
    Typedef(Box<TypedefFrame>),
    Term(Box<TermFrame>),
    Instance(Box<InstanceFrame>),
}

An entity frame, describing either a term, an instance, or a typedef.

Ordering

Serializer conventions dictate that frames should be Serialized first with [Typedef] frames, then [Term], and then [Instance], which is reflected here in the order of the variants.

Variants

Typedef(Box<TypedefFrame>)

Term(Box<TermFrame>)

Instance(Box<InstanceFrame>)

Implementations

impl EntityFrame

pub fn as_term(&self) -> Option<&TermFrame>

Return a reference to the TermFrame if the entity frame is one, or None.

Use this function in conjunction with Iterator::flat_map to extract all term frames from an iterator of EntityFrame references:

let doc = fastobo::from_file("tests/data/ms.obo").unwrap();
let terms: Vec<&TermFrame> = doc
    .entities()
    .iter()
    .flat_map(EntityFrame::as_term)
    .collect();

pub fn as_term_mut(&mut self) -> Option<&mut TermFrame>

Return a mutable reference to the TermFrame if the entity frame is one, or None.

pub fn as_typedef(&self) -> Option<&TypedefFrame>

Return a reference to the TypedefFrame if the entity frame is one, or None.

pub fn as_typedef_mut(&mut self) -> Option<&mut TypedefFrame>

Return a mutable reference to the TypedefFrame if the entity frame is one, or None.

pub fn as_instance(&self) -> Option<&InstanceFrame>

Return a reference to the InstanceFrame if the entity frame is one, or None.

pub fn as_instance_mut(&mut self) -> Option<&mut InstanceFrame>

Return a mutable reference to the InstanceFrame if the entity frame is one, or None.

pub fn name(&self) -> Result<&UnquotedString, CardinalityError>

Get the name of the entity, if exactly one is declared.

pub fn definition(&self) -> Result<&Definition, CardinalityError>

Get the definition of the entity, if exactly one is declared.

Trait Implementations

impl Clone for EntityFrame

fn clone(&self) -> EntityFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityFrame

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

Formats the value using the given formatter.

impl Display for EntityFrame

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

Formats the value using the given formatter.

impl From<EntityFrame> for Frame

fn from(frame: EntityFrame) -> Self

Converts to this type from the input type.

impl From<InstanceFrame> for EntityFrame

fn from(frame: InstanceFrame) -> Self

Converts to this type from the input type.

impl From<TermFrame> for EntityFrame

fn from(frame: TermFrame) -> Self

Converts to this type from the input type.

impl From<TypedefFrame> for EntityFrame

fn from(frame: TypedefFrame) -> Self

Converts to this type from the input type.

impl<'i> FromPair<'i> for EntityFrame

const RULE: Rule = Rule::EntityFrame

The production rule the pair is expected to be obtained from.

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

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

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

Create a new instance from a Pair.

impl FromStr for EntityFrame

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.

impl Hash for EntityFrame

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Identified for EntityFrame

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 Orderable for EntityFrame

fn sort(&mut self)

Sort the elements of the collection in the right serialization order.

fn is_sorted(&self) -> bool

Check if the collection is sorted in the right serialization order.

impl PartialEq for EntityFrame

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for EntityFrame

impl StructuralPartialEq for EntityFrame