pub struct QueryResultsParser { /* private fields */ }
Expand description
Parsers for SPARQL query results serialization formats.
It currently supports the following formats:
- SPARQL Query Results XML Format (
QueryResultsFormat::Xml
). - SPARQL Query Results JSON Format (
QueryResultsFormat::Json
). - SPARQL Query Results TSV Format (
QueryResultsFormat::Tsv
).
Example in JSON (the API is the same for XML and TSV):
use sparesults::{QueryResultsFormat, QueryResultsParser, ReaderQueryResultsParserOutput};
use oxrdf::{Literal, Variable};
let json_parser = QueryResultsParser::from_format(QueryResultsFormat::Json);
// boolean
if let ReaderQueryResultsParserOutput::Boolean(v) = json_parser.clone().for_reader(br#"{"boolean":true}"#.as_slice())? {
assert_eq!(v, true);
}
// solutions
if let ReaderQueryResultsParserOutput::Solutions(solutions) = json_parser.for_reader(br#"{"head":{"vars":["foo","bar"]},"results":{"bindings":[{"foo":{"type":"literal","value":"test"}}]}}"#.as_slice())? {
assert_eq!(solutions.variables(), &[Variable::new("foo")?, Variable::new("bar")?]);
for solution in solutions {
assert_eq!(solution?.iter().collect::<Vec<_>>(), vec![(&Variable::new("foo")?, &Literal::from("test").into())]);
}
}
Implementations§
Source§impl QueryResultsParser
impl QueryResultsParser
Sourcepub fn from_format(format: QueryResultsFormat) -> QueryResultsParser
pub fn from_format(format: QueryResultsFormat) -> QueryResultsParser
Builds a parser for the given format.
Sourcepub fn for_reader<R>(
self,
reader: R,
) -> Result<ReaderQueryResultsParserOutput<R>, QueryResultsParseError>where
R: Read,
pub fn for_reader<R>(
self,
reader: R,
) -> Result<ReaderQueryResultsParserOutput<R>, QueryResultsParseError>where
R: Read,
Reads a result file from a Read
implementation.
Reads are automatically buffered.
Example in XML (the API is the same for JSON and TSV):
use sparesults::{QueryResultsFormat, QueryResultsParser, ReaderQueryResultsParserOutput};
use oxrdf::{Literal, Variable};
let xml_parser = QueryResultsParser::from_format(QueryResultsFormat::Xml);
// boolean
if let ReaderQueryResultsParserOutput::Boolean(v) = xml_parser.clone().for_reader(br#"<sparql xmlns="http://www.w3.org/2005/sparql-results#"><head/><boolean>true</boolean></sparql>"#.as_slice())? {
assert_eq!(v, true);
}
// solutions
if let ReaderQueryResultsParserOutput::Solutions(solutions) = xml_parser.for_reader(br#"<sparql xmlns="http://www.w3.org/2005/sparql-results#"><head><variable name="foo"/><variable name="bar"/></head><results><result><binding name="foo"><literal>test</literal></binding></result></results></sparql>"#.as_slice())? {
assert_eq!(solutions.variables(), &[Variable::new("foo")?, Variable::new("bar")?]);
for solution in solutions {
assert_eq!(solution?.iter().collect::<Vec<_>>(), vec![(&Variable::new("foo")?, &Literal::from("test").into())]);
}
}
pub fn read_results<R>(
&self,
reader: R,
) -> Result<ReaderQueryResultsParserOutput<R>, QueryResultsParseError>where
R: Read,
👎Deprecated since 0.4.0: use for_read
Sourcepub fn for_slice(
self,
slice: &[u8],
) -> Result<SliceQueryResultsParserOutput<'_>, QueryResultsSyntaxError>
pub fn for_slice( self, slice: &[u8], ) -> Result<SliceQueryResultsParserOutput<'_>, QueryResultsSyntaxError>
Reads a result file from a Read
implementation.
Reads are automatically buffered.
Example in XML (the API is the same for JSON and TSV):
use sparesults::{QueryResultsFormat, QueryResultsParser, SliceQueryResultsParserOutput};
use oxrdf::{Literal, Variable};
let xml_parser = QueryResultsParser::from_format(QueryResultsFormat::Xml);
// boolean
if let SliceQueryResultsParserOutput::Boolean(v) = xml_parser.clone().for_slice(br#"<sparql xmlns="http://www.w3.org/2005/sparql-results#"><head/><boolean>true</boolean></sparql>"#)? {
assert_eq!(v, true);
}
// solutions
if let SliceQueryResultsParserOutput::Solutions(solutions) = xml_parser.for_slice(br#"<sparql xmlns="http://www.w3.org/2005/sparql-results#"><head><variable name="foo"/><variable name="bar"/></head><results><result><binding name="foo"><literal>test</literal></binding></result></results></sparql>"#)? {
assert_eq!(solutions.variables(), &[Variable::new("foo")?, Variable::new("bar")?]);
for solution in solutions {
assert_eq!(solution?.iter().collect::<Vec<_>>(), vec![(&Variable::new("foo")?, &Literal::from("test").into())]);
}
}
Trait Implementations§
Source§impl Clone for QueryResultsParser
impl Clone for QueryResultsParser
Source§fn clone(&self) -> QueryResultsParser
fn clone(&self) -> QueryResultsParser
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl From<QueryResultsFormat> for QueryResultsParser
impl From<QueryResultsFormat> for QueryResultsParser
Source§fn from(format: QueryResultsFormat) -> QueryResultsParser
fn from(format: QueryResultsFormat) -> QueryResultsParser
Converts to this type from the input type.
Auto Trait Implementations§
impl Freeze for QueryResultsParser
impl RefUnwindSafe for QueryResultsParser
impl Send for QueryResultsParser
impl Sync for QueryResultsParser
impl Unpin for QueryResultsParser
impl UnwindSafe for QueryResultsParser
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more