1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
/*!  This crate provides traits for reading and writing `Statement`s and `Graph`s as well as implementations of these for common representations. The following are some well-known formats (see [Wikipedia](https://en.wikipedia.org/wiki/Resource_Description_Framework#Serialization_formats) for a description of different serializations), support is indicated in the final column with an **R** for read support and **W** for write support. One additional module, `dot` allows for the creation of [GraphViz](https://graphviz.gitlab.io/) dot files for a visualization of a graph's structure. | Module | Name | MIME Type | R/W | |-----------|---------------------------------------------------------------------------------------------------- |-----------------------------|---------| | `nt` | [RDF 1.1 N-Triples](https://www.w3.org/TR/n-triples/); A line-based syntax for an RDF graph | `application/n-triples` | **R+W** | | `nq` | [RDF 1.1 N-Quads](https://www.w3.org/TR/n-quads/); A line-based syntax for RDF datasets | `application/n-quads` | **W** | | `turtle` | [RDF 1.1 Turtle](https://www.w3.org/TR/turtle/); Terse RDF Triple Language | `text/turtle` | **W** | | `trig` | [RDF 1.1 TriG](https://www.w3.org/TR/trig/); RDF Dataset Language | `application/trig` | | | `xml` | [RDF 1.1 XML Syntax](https://www.w3.org/TR/rdf-syntax-grammar/) | `application/rdf+xml` | **W** | | `json` | [RDF 1.1 JSON Alternate Serialization](https://www.w3.org/TR/rdf-json/) | `application/rdf+json` | **W** | | `n3` | [Notation3 (N3): A readable RDF syntax](https://www.w3.org/TeamSubmission/n3/) | `text/rdf+n3` | **W** | | TBD | [Binary RDF Representation for Publication and Exchange (HDT)](https://www.w3.org/Submission/HDT/) | N/A | | | TBD | [RDF Binary using Apache Thrift](https://afs.github.io/rdf-thrift/) | `application/x-binary-rdf` | | | TBD | [JSON-LD 1.1](https://www.w3.org/TR/json-ld/); A JSON-based Serialization for Linked Data | `application/ld+json` | | | TBD | [RDFa Core 1.1 - Third Edition](https://www.w3.org/TR/rdfa-core/) | `text/html` | | Each module will also provide public constants `NAME`, `FILE_EXTENSION`, and `MIME_TYPE`. # Example An example, reading an existing NTriple file. ```rust use rdftk_io::nt::reader::NTriplesReader; use rdftk_io::GraphReader; use rdftk_core::simple::graph_factory; use std::fs::File; use std::path::PathBuf; let file_path = PathBuf::from("tests/w3c/nt/literal.nt"); let mut file = File::open(file_path).unwrap(); let reader = NTriplesReader::default(); let graph = reader.read(&mut file, graph_factory()).unwrap(); ``` */ #![warn( // ---------- Stylistic future_incompatible, nonstandard_style, rust_2018_idioms, trivial_casts, trivial_numeric_casts, // ---------- Public missing_debug_implementations, missing_docs, unreachable_pub, // ---------- Unsafe unsafe_code, // ---------- Unused unused_extern_crates, unused_import_braces, unused_qualifications, unused_results, )] #[macro_use] extern crate lazy_static; #[macro_use] extern crate log; #[cfg(any(feature = "nt", feature = "turtle"))] #[macro_use] extern crate pest_derive; use rdftk_core::error::Result; use rdftk_core::model::data_set::DataSetRef; use rdftk_core::model::graph::{GraphFactoryRef, GraphRef}; use std::io::{Read, Write}; // ------------------------------------------------------------------------------------------------ // Public Types // ------------------------------------------------------------------------------------------------ /// /// Read an entire `Graph` from the provided implementation of /// [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html). /// pub trait GraphReader { /// Read a graph from the read implementation `r`. fn read(&self, r: &mut impl Read, factory: GraphFactoryRef) -> Result<GraphRef>; } // ------------------------------------------------------------------------------------------------ /// /// Write all [`Statement`](../rdftk_core/statement/struct.Statement.html)s in the /// [`Graph`](../rdftk_graph/graph/trait.Graph.html) using the provided implementation of /// [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html). /// pub trait GraphWriter { /// Write the formatted graph `Graph` using the write implementation `w`. fn write(&self, w: &mut impl Write, graph: &GraphRef) -> Result<()>; } /// /// Write all [`Graph`](../rdftk_graph/graph/trait.Graph.html)s in the /// [`DataSet`](../rdftk_graph/model.data_set/trait.DataSet.html) using the provided implementation of /// [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html). /// pub trait DataSetWriter { /// Write the formatted graph `NamedGraph` using the write implementation `w`. fn write(&self, w: &mut impl Write, data_set: &DataSetRef) -> Result<()>; } // ------------------------------------------------------------------------------------------------ // Public Functions // ------------------------------------------------------------------------------------------------ /// /// A convenience function that will return a String containing the output of the `GraphWriter` /// for the given `Graph` instance. /// pub fn write_graph_to_string(w: &impl GraphWriter, graph: &GraphRef) -> Result<String> { use std::io::Cursor; let mut buffer = Cursor::new(Vec::new()); w.write(&mut buffer, graph)?; Ok(String::from_utf8(buffer.into_inner()).unwrap()) } /// /// A convenience function that will return a String containing the output of the `NamedGraphWriter` /// for the given `NamedGraph` instance. /// pub fn write_data_set_to_string(w: &impl DataSetWriter, data_set: &DataSetRef) -> Result<String> { use std::io::Cursor; let mut buffer = Cursor::new(Vec::new()); w.write(&mut buffer, data_set)?; Ok(String::from_utf8(buffer.into_inner()).unwrap()) } // ------------------------------------------------------------------------------------------------ // Modules // ------------------------------------------------------------------------------------------------ #[macro_use] mod common; #[cfg(feature = "dot")] pub mod dot; #[cfg(feature = "json")] pub mod json; #[cfg(feature = "n3")] #[doc(hidden)] pub mod n3; #[cfg(feature = "nq")] pub mod nq; #[cfg(feature = "nt")] pub mod nt; #[cfg(feature = "trig")] #[doc(hidden)] pub mod trig; #[cfg(feature = "turtle")] #[doc(hidden)] pub mod turtle; #[cfg(feature = "xml")] pub mod xml;