Struct RdfSerializer

Source

pub struct RdfSerializer { /* private fields */ }

Expand description

A serializer for RDF serialization formats.

It currently supports the following formats:

N3 (RdfFormat::N3)
N-Quads (RdfFormat::NQuads)
canonical N-Triples (RdfFormat::NTriples)
RDF/XML (RdfFormat::RdfXml)
TriG (RdfFormat::TriG)
Turtle (RdfFormat::Turtle)

use oxrdfio::{RdfFormat, RdfSerializer};
use oxrdf::{Quad, NamedNode};

let mut serializer = RdfSerializer::from_format(RdfFormat::NQuads).for_writer(Vec::new());
serializer.serialize_quad(&Quad {
   subject: NamedNode::new("http://example.com/s")?.into(),
   predicate: NamedNode::new("http://example.com/p")?,
   object: NamedNode::new("http://example.com/o")?.into(),
   graph_name: NamedNode::new("http://example.com/g")?.into()
})?;
assert_eq!(serializer.finish()?, b"<http://example.com/s> <http://example.com/p> <http://example.com/o> <http://example.com/g> .\n");

Implementations§

Source §

impl RdfSerializer

Source

pub fn from_format(format: RdfFormat) -> RdfSerializer

Builds a serializer for the given format

Source

pub fn format(&self) -> RdfFormat

The format the serializer serializes to.

use oxrdfio::{RdfFormat, RdfSerializer};

assert_eq!(
    RdfSerializer::from_format(RdfFormat::Turtle).format(),
    RdfFormat::Turtle
);

Source

pub fn with_prefix( self, prefix_name: impl Into<String>, prefix_iri: impl Into<String>, ) -> Result<RdfSerializer, IriParseError>

If the format supports it, sets a prefix.

use oxrdf::vocab::rdf;
use oxrdf::{NamedNodeRef, TripleRef};
use oxrdfio::{RdfFormat, RdfSerializer};

let mut serializer = RdfSerializer::from_format(RdfFormat::Turtle)
    .with_prefix("schema", "http://schema.org/")?
    .for_writer(Vec::new());
serializer.serialize_triple(TripleRef {
    subject: NamedNodeRef::new("http://example.com/s")?.into(),
    predicate: rdf::TYPE.into(),
    object: NamedNodeRef::new("http://schema.org/Person")?.into(),
})?;
assert_eq!(
    serializer.finish()?,
    b"@prefix schema: <http://schema.org/> .\n<http://example.com/s> a schema:Person .\n"
);

Source

pub fn with_base_iri( self, base_iri: impl Into<String>, ) -> Result<RdfSerializer, IriParseError>

If the format supports it, sets a base IRI.

use oxrdf::vocab::rdf;
use oxrdf::{NamedNodeRef, TripleRef};
use oxrdfio::{RdfFormat, RdfSerializer};

let mut serializer = RdfSerializer::from_format(RdfFormat::Turtle)
    .with_base_iri("http://example.com")?
    .with_prefix("ex", "http://example.com/ns#")?
    .for_writer(Vec::new());
serializer.serialize_triple(TripleRef::new(
    NamedNodeRef::new("http://example.com/me")?,
    rdf::TYPE,
    NamedNodeRef::new("http://example.com/ns#Person")?,
))?;
assert_eq!(
    serializer.finish()?,
    b"@base <http://example.com> .\n@prefix ex: </ns#> .\n</me> a ex:Person .\n",
);

Source

pub fn for_writer<W>(self, writer: W) -> WriterQuadSerializer<W>
where W: Write,

Serializes to a Write implementation.

Do not forget to run the finish method to properly write the last bytes of the file.

This writer does unbuffered writes. You might want to use BufWriter to avoid that.

use oxrdfio::{RdfFormat, RdfSerializer};
use oxrdf::{Quad, NamedNode};

let mut serializer = RdfSerializer::from_format(RdfFormat::NQuads).for_writer(Vec::new());
serializer.serialize_quad(&Quad {
   subject: NamedNode::new("http://example.com/s")?.into(),
   predicate: NamedNode::new("http://example.com/p")?,
   object: NamedNode::new("http://example.com/o")?.into(),
   graph_name: NamedNode::new("http://example.com/g")?.into()
})?;
assert_eq!(serializer.finish()?, b"<http://example.com/s> <http://example.com/p> <http://example.com/o> <http://example.com/g> .\n");