Struct ShExFormatter

pub struct ShExFormatter { /* private fields */ }

Struct that can be used to pretty print ShEx schemas

Example:

use shex_compact::ShExFormatter;
use shex_ast::{Schema, ShapeExprLabel, ShapeExpr};
use iri_s::IriS;

let mut schema = Schema::new();
schema.add_prefix("ex", &IriS::new_unchecked("http://example.org/"));
schema.add_shape(ShapeExprLabel::iri_unchecked("http://example.org/S"), ShapeExpr::empty_shape(), false);

let expected = r#"prefix ex: <http://example.org/>
ex:S {  }"#;

assert_eq!(ShExFormatter::default().format_schema(&schema), expected);

Implementations

impl ShExFormatter

pub fn keyword_color(&self) -> Option<Color>

pub fn prefix_color(&self) -> Option<Color>

pub fn semicolon_color(&self) -> Option<Color>

pub fn localname_color(&self) -> Option<Color>

pub fn with_keyword_color(self, color: Option<Color>) -> ShExFormatter

pub fn with_prefix_color(self, color: Option<Color>) -> ShExFormatter

pub fn with_semicolon_color(self, color: Option<Color>) -> ShExFormatter

pub fn with_string_color(self, color: Option<Color>) -> ShExFormatter

pub fn with_localname_color(self, color: Option<Color>) -> ShExFormatter

pub fn without_colors(self) -> ShExFormatter

Changes the formatter to avoid showing colors

pub fn format_schema(&self, schema: &Schema) -> String

pub fn write_schema<W>( &self, schema: &Schema, writer: &mut W, ) -> Result<(), Error>

where W: Write,

Trait Implementations

impl Clone for ShExFormatter

fn clone(&self) -> ShExFormatter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ShExFormatter

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

Formats the value using the given formatter.

impl Default for ShExFormatter

fn default() -> ShExFormatter

Returns the “default value” for a type.