Struct ComponentReference 

#[non_exhaustive]
pub struct ComponentReference {
    pub identity: Resource,
    pub identified: IdentifiedData,
    pub feature: FeatureData,
    pub in_child_of: Option<Resource>,
    pub refers_to: Option<Resource>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

identity: Resource

identified: IdentifiedData

feature: FeatureData

in_child_of: Option<Resource>

refers_to: Option<Resource>

Implementations

impl ComponentReference

pub fn new( parent: &Resource, display_id: impl TryInto<DisplayId, Error = BuildError>, in_child_of: Resource, refers_to: Resource, ) -> Result<Self, BuildError>

pub fn builder( parent: &Resource, display_id: impl TryInto<DisplayId, Error = BuildError>, ) -> Result<ComponentReferenceBuilder, BuildError>

impl ComponentReference

pub fn parent_component<'a>(&self, doc: &'a Document) -> Option<&'a Component>

Returns the Component that owns this feature via sbol:hasFeature, or None if no enclosing component is in the document. SBOL features must belong to exactly one component, so a Some result is unambiguous.

impl ComponentReference

pub fn target<'a, G>( &self, graph: &'a G, ) -> Result<FeatureRef<'a>, ReferenceError>

where G: ObjectGraph + ?Sized,

Resolves the leaf FeatureRef that this reference points at.

Equivalent to ComponentReference::trace followed by FeatureTrace::target. Use trace when the intermediate hops matter.

pub fn trace<'a, G>( &self, graph: &'a G, ) -> Result<FeatureTrace<'a>, ReferenceError>

where G: ObjectGraph + ?Sized,

Walks the refersTo chain from this reference to its leaf feature.

Returns a FeatureTrace carrying the resolved FeatureRef plus the IRIs of every intermediate ComponentReference crossed.

Errors

• ReferenceError::Missing when this reference (or a node along the chain) has no refersTo.
• ReferenceError::NotFound when an IRI along the chain is absent from graph.
• ReferenceError::WrongType when the leaf is not a recognized Feature subclass.
• ReferenceError::Cycle when the chain loops back on itself.

Trait Implementations

impl Clone for ComponentReference

fn clone(&self) -> ComponentReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentReference

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

Formats the value using the given formatter.

impl PartialEq for ComponentReference

fn eq(&self, other: &ComponentReference) -> 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 SbolIdentified for ComponentReference

fn identified_data(&self) -> &IdentifiedData

Returns the underlying IdentifiedData this accessor reads from. Implementors only need to forward to their identified field.

fn display_id(&self) -> Option<&str>

The object’s sbol:displayId, if present.

fn name(&self) -> Option<&str>

The object’s sbol:name, if present.

fn description(&self) -> Option<&str>

The object’s sbol:description, if present.

fn derived_from(&self) -> &[Resource]

Resources this object lists as prov:wasDerivedFrom.

fn generated_by(&self) -> &[Resource]

Resources this object lists as prov:wasGeneratedBy.

fn measures(&self) -> &[Resource]

OM Measure resources attached via sbol:hasMeasure.

fn extensions(&self) -> &[ExtensionTriple]

Non-SBOL annotation triples preserved on this object’s identity.

impl ToRdf for ComponentReference

fn to_rdf_triples(&self) -> Result<Vec<Triple>, BuildError>

impl TryFromObject for ComponentReference

fn try_from_object(object: &Object) -> Option<Self>

impl Eq for ComponentReference

impl StructuralPartialEq for ComponentReference