Struct fog_pack::schema::SchemaBuilder

pub struct SchemaBuilder { /* fields omitted */ }

Builds schemas up from Validators.

A schema can be directly made from any document, but it’s generally much easier to construct them from Validator structs and turn the result into a Document.

Implementations

impl SchemaBuilder

pub fn new(doc: Validator) -> Self

Start building a new schema. Requires the validator to use for any documents adhering to this schema.

pub fn description(self, description: &str) -> Self

Set the schema description. This is only used for documentation purposes.

pub fn doc_compress(self, doc_compress: Compress) -> Self

Set the default compression to use for documents adhering to this schema.

pub fn entry_add(
    self,
    entry: &str,
    validator: Validator,
    compress: Option<Compress>
) -> Self

Add a new entry type to the schema, where entry is the key for the entry, validator will be used to validate each entry, and compress optionally overrides the default compression with a specific compression setting.

pub fn name(self, name: &str) -> Self

Set the schema name. This is only used for documentation purposes.

pub fn type_add(self, type_ref: &str, validator: Validator) -> Self

Add a new stored type to the schema.

pub fn version<T: Into<Integer>>(self, version: T) -> Self

Set the schema version. This is only used for documentation purposes.

pub fn build(self) -> Result<Document>

Build the Schema, compiling the result into a Document