Skip to main content

Crate sbol2

Crate sbol2 

Source
Expand description

Rust implementation of the SBOL 2.3.0 specification.

sbol2 is the SBOL 2 peer of the sbol3 crate. It builds on the version-neutral machinery in sbol_core (the field-metadata descriptors, identity newtypes, RDF-backed document store) and layers on the SBOL 2 typed data model, its RDF serialization, and a shared field-metadata catalog. Most users reach it through the umbrella sbol crate as sbol::v2.

Modules§

constants
Common ontology IRIs for building SBOL 2 documents.
identity
Validated identity helpers used by the typed builder surface.
prelude
Convenient re-exports for typical SBOL 2 construction and inspection workflows. use sbol2::prelude::*; brings the typed objects, builders, document, identity newtypes, and the SbolIdentified / SbolTopLevel accessor traits into scope.
schema
Field-metadata catalog for the SBOL 2 data model.
validation
SBOL 2 validation: a rule catalog generated from rules.toml, the shared reporting and configuration types from sbol_core, and the engine that evaluates a document against the catalog.

Structs§

Activity
ActivityBuilder
Builder for Activity.
Agent
AgentBuilder
Builder for the corresponding PROV-O TopLevel class.
Association
AssociationBuilder
Builder for Association.
Attachment
AttachmentBuilder
Builder for the corresponding SBOL 2 TopLevel class.
BinaryPrefix
BinaryPrefixBuilder
Builder for the corresponding OM Prefix-hierarchy class.
Collection
CollectionBuilder
Builder for the corresponding SBOL 2 TopLevel class.
CombinatorialDerivation
CombinatorialDerivationBuilder
Builder for the corresponding SBOL 2 TopLevel class.
Component
ComponentBuilder
Builder for Component.
ComponentDefinition
ComponentDefinitionBuilder
Builder for the corresponding SBOL 2 TopLevel class.
ComponentInstanceData
Shared owned fields for the abstract ComponentInstance mixin.
CompoundUnit
CompoundUnitBuilder
Builder for the corresponding OM Unit-hierarchy class.
Cut
CutBuilder
Builder for Cut.
Diff
The identity-keyed difference between two SBOL documents.
DisplayId
A validated SBOL displayId.
Document
An SBOL 2 document parsed from RDF.
Experiment
ExperimentBuilder
Builder for the corresponding SBOL 2 TopLevel class.
ExperimentalData
ExperimentalDataBuilder
Builder for the corresponding SBOL 2 TopLevel class.
ExtensionTriple
A non-SBOL annotation triple attached to a typed object.
FunctionalComponent
FunctionalComponentBuilder
Builder for FunctionalComponent.
GenericLocation
GenericLocationBuilder
Builder for GenericLocation.
GenericTopLevel
A sbol2:GenericTopLevel: a user-extension TopLevel whose custom RDF class is carried in the sbol2:rdfType property alongside arbitrary extension triples.
GenericTopLevelBuilder
Builder for GenericTopLevel.
HashAlgorithm
A validated hash algorithm token for Attachment.hashAlgorithm.
Identified
Shared fields on Identified objects.
IdentifiedData
Shared owned fields for SBOL 2 Identified objects.
IdentifiedExtension
An RDF subject preserved through the typed model when no concrete SBOL 2 class variant matched its rdf:type set. The rdf_types vector preserves every original rdf:type IRI so re-serialization emits exactly what the parser saw.
IdentifiedExtensionBuilder
Builder for IdentifiedExtension.
Implementation
ImplementationBuilder
Builder for the corresponding SBOL 2 TopLevel class.
Interaction
InteractionBuilder
Builder for Interaction.
Iri
An RDF IRI.
Literal
RDF literal lexical data.
LocationData
Shared owned fields for the abstract Location mixin.
MapsTo
MapsToBuilder
Builder for MapsTo.
Measure
MeasureBuilder
Builder for Measure.
MeasuredData
Shared owned fields for the abstract Measured mixin.
Model
ModelBuilder
Builder for the corresponding SBOL 2 TopLevel class.
Module
ModuleBuilder
Builder for Module.
ModuleDefinition
ModuleDefinitionBuilder
Builder for the corresponding SBOL 2 TopLevel class.
Namespace
A validated SBOL namespace URL.
Object
An SBOL or SBOL extension object.
ObjectDiff
The change to a single object present in both documents.
Participation
ParticipationBuilder
Builder for Participation.
Plan
PlanBuilder
Builder for the corresponding PROV-O TopLevel class.
Prefix
PrefixBuilder
Builder for the corresponding OM Prefix-hierarchy class.
PrefixData
Shared OM Prefix fields, carried by every concrete Prefix subclass.
PrefixedUnit
PrefixedUnitBuilder
Builder for the corresponding OM Unit-hierarchy class.
PropertyChange
The change to the values of one predicate on a changed object.
Range
RangeBuilder
Builder for Range.
RawDocument
An RDF graph paired with its parsed, identity-indexed objects.
RdfGraph
Backend-opaque in-memory RDF graph.
SIPrefix
SIPrefixBuilder
Builder for the corresponding OM Prefix-hierarchy class.
SbolIdentity
A namespace + displayId pair that resolves to a compliant SBOL identity URL.
Sequence
SequenceAnnotation
SequenceAnnotationBuilder
Builder for SequenceAnnotation.
SequenceBuilder
Builder for the corresponding SBOL 2 TopLevel class.
SequenceConstraint
SequenceConstraintBuilder
Builder for SequenceConstraint.
SequenceElements
A sequence’s elements literal paired with its encoding IRI.
SingularUnit
SingularUnitBuilder
Builder for the corresponding OM Unit-hierarchy class.
TopLevel
Shared fields on TopLevel objects.
TopLevelData
Shared owned fields for SBOL 2 TopLevel objects. SBOL 2 has no hasNamespace, so only the attachment set lives here.
Triple
An RDF triple in the default graph.
Unit
UnitBuilder
Builder for the corresponding OM Unit-hierarchy class.
UnitData
Shared OM Unit fields, carried by every concrete Unit subclass.
UnitDivision
UnitDivisionBuilder
Builder for the corresponding OM Unit-hierarchy class.
UnitExponentiation
UnitExponentiationBuilder
Builder for the corresponding OM Unit-hierarchy class.
UnitMultiplication
UnitMultiplicationBuilder
Builder for the corresponding OM Unit-hierarchy class.
Usage
UsageBuilder
Builder for Usage.
VariableComponent
VariableComponentBuilder
Builder for VariableComponent.

Enums§

BuildError
Errors produced while building an SBOL document from owned typed objects.
RdfFormat
RDF serialization format.
ReadError
Errors produced while reading an SBOL document.
Resource
RDF subject resource.
Sbol2Class
SBOL RDF classes handled by this crate.
Sbol2Object
Owned SBOL 2 object variants supported by the client API.
Term
RDF object term.
WriteError
Errors produced while writing an SBOL document.

Traits§

ObjectClasses
Classifies an Object against the SBOL 2 class hierarchy.
ObjectStore
Read access to a document’s RDF-backed objects, indexed by identity.
SbolIdentified
Read-only access to the shared metadata every SBOL 2 Identified object carries: persistentIdentity, version, displayId, name (dcterms:title), description (dcterms:description), the PROV wasDerivedFrom / wasGeneratedBy resource sets, and round-tripped non-SBOL extension triples.
SbolTopLevel
Read-only access to the metadata SBOL 2 TopLevel objects carry on top of SbolIdentified: the attached sbol:Attachment resources.
ToRdf
Converts an owned typed SBOL value into RDF triples.
TryFromObject
Converts an RDF-collected object into an owned typed SBOL value.

Functions§

render_sbol2_conformance_report
Renders the SBOL 2 conformance report markdown for the supplied rule catalog. Pass validation_rule_statuses() to render the canonical committed report.