Struct Rudof

pub struct Rudof { /* private fields */ }

This represents the public API to interact with rudof

Implementations

impl Rudof

pub fn new(config: &RudofConfig) -> Rudof

pub fn config(&self) -> &RudofConfig

pub fn update_config(&mut self, config: &RudofConfig)

pub fn reset_data(&mut self)

Resets the current RDF Data

pub fn reset_dctap(&mut self)

Resets the current DCTAP

pub fn reset_shacl(&mut self)

Resets the current SHACL shapes graph

pub fn reset_all(&mut self)

Resets all current values

pub fn get_shacl_from_data(&mut self) -> Result<()>

Get the shapes graph schema from the current RDF data

pub fn get_shacl(&self) -> Option<&ShaclSchema>

Get the current SHACL

pub fn get_shex(&self) -> Option<&ShExSchema>

Get the current ShEx Schema

pub fn get_dctap(&self) -> Option<&DCTAP>

Get the current DCTAP

pub fn get_shapemap(&self) -> Option<&QueryShapeMap>

Get the current shapemap

pub fn dctap2shex(&mut self) -> Result<()>

Converts the current DCTAP to a ShExSchema Stores the value of the ShExSchema in the current shex

pub fn shex2plant_uml<W: Write>( &self, mode: &UmlGenerationMode, writer: &mut W, ) -> Result<()>

Generate a UML Class-like representation of a ShEx schema according to PlantUML syntax

pub fn serialize_data<W: Write>( &self, format: &RDFFormat, writer: &mut W, ) -> Result<()>

pub fn serialize_shapemap<W: Write>( &self, format: &ShapeMapFormat, formatter: &ShapeMapFormatter, writer: &mut W, ) -> Result<()>

Serialize the current ShapeMap

pub fn serialize_shex<W: Write>( &self, format: &ShExFormat, formatter: &ShExFormatter, writer: &mut W, ) -> Result<()>

Serialize the current ShEx Schema

pub fn run_query_str(&mut self, str: &str) -> Result<QuerySolutions<RdfData>>

pub fn run_query<R: Read>( &mut self, reader: &mut R, ) -> Result<QuerySolutions<RdfData>>

pub fn serialize_shacl<W: Write>( &self, format: &ShaclFormat, writer: &mut W, ) -> Result<()>

pub fn reset_validation_results(&mut self)

Resets the current ShEx validation results The action is necessary to start a fresh validation

pub fn reset_shex(&mut self)

Resets the current validator This operation removes the current shex_schema

pub fn read_shacl<R: Read>( &mut self, reader: R, format: &ShaclFormat, base: Option<&str>, reader_mode: &ReaderMode, ) -> Result<()>

Reads a SHACL schema from a reader

• base is used to resolve relative IRIs
• format indicates the Shacl format

pub fn read_dctap<R: Read>( &mut self, reader: R, format: &DCTAPFormat, ) -> Result<()>

Reads a DCTAP and replaces the current one

• format indicates the DCTAP format

pub fn read_dctap_path<P: AsRef<Path>>( &mut self, path: P, format: &DCTAPFormat, ) -> Result<()>

Reads a DCTAP and replaces the current one

• format indicates the DCTAP format

pub fn read_shex<R: Read>( &mut self, reader: R, format: &ShExFormat, base: Option<&str>, ) -> Result<()>

Reads a ShExSchema and replaces the current one It also updates the current ShEx validator with the new ShExSchema

• base is used to resolve relative IRIs
• format indicates the ShEx format according to ShExFormat

pub fn validate_shacl( &mut self, mode: &ShaclValidationMode, shapes_graph_source: &ShapesGraphSource, ) -> Result<ValidationReport>

Validate RDF data using SHACL

mode: Indicates whether to use SPARQL or native Rust implementation shapes_graph_source: Indicates the source of the shapes graph, which can be extracted from the current RDF data, or from the current SHACL schema. If there is no current SHACL schema, it tries to get it from the current RDF data

pub fn validate_shex(&mut self) -> Result<ResultShapeMap>

Validate RDF data using ShEx It uses a ShEx validator which is current ShEx schema and the current ShapeMap that should

pub fn add_endpoint(&mut self, iri: &IriS, prefixmap: &PrefixMap) -> Result<()>

Adds an endpoint to the current RDF data

pub fn read_data<R: Read>( &mut self, reader: R, format: &RDFFormat, base: Option<&str>, reader_mode: &ReaderMode, ) -> Result<()>

Parses an RDF graph from a reader and merges it with the current graph

pub fn clean_rdf_graph(&mut self)

Cleans the in-memory graph

pub fn shapemap_add_node_shape_selectors( &mut self, node: NodeSelector, shape: ShapeSelector, )

Add a pair of node selector and shape selector to the current shapemap

pub fn read_shapemap<R: Read>( &mut self, reader: R, shapemap_format: &ShapeMapFormat, ) -> Result<()>

Read a shapemap

pub fn reset_shapemap(&mut self)

pub fn nodes_prefixmap(&self) -> PrefixMap

Returns the RDF data prefixmap

pub fn shex_shapes_prefixmap(&self) -> Option<PrefixMap>

Returns the shapes prefixmap

If no ShEx schema has been set, returns None

pub fn get_rdf_data(&self) -> &RdfData

Get current RDF Data

pub fn shex_schema_without_imports(&mut self) -> Result<SchemaWithoutImports>

Obtains the current shex_schema after resolving import declarations

If the import declarations in the current schema have not been resolved, it resolves them

Trait Implementations

impl Debug for Rudof

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

Formats the value using the given formatter.

impl Send for Rudof