Struct Document

pub struct Document { /* private fields */ }

One IFCX file held by a host.

The host keeps this handle rather than a plain object, so writing it back is lossless: key order, unknown fields, null deletions and every number stay exactly as read, which a JavaScript object would not guarantee.

Implementations

impl Document

pub fn parse(bytes: &[u8]) -> Result<Self, BindingError>

Reads an IFCX file from its UTF-8 JSON bytes.

pub fn write(&self, pretty: bool) -> Result<String, BindingError>

The file as JSON text: compact, or indented by two spaces.

pub fn header_json(&self) -> Result<String, BindingError>

The header object as JSON text.

pub fn node_count(&self) -> usize

Number of entries in data. Several may share a path.

pub fn validate_json(&self) -> String

Checks every attribute against this file’s own schemas and returns the report as JSON text (see LayerSet::validate_json for the shape). Imports are not resolved, so an attribute whose schema lives only in an imported file is reported as missing-schema.

pub fn file(&self) -> &IfcxFile

The file this document holds.

pub fn into_file(self) -> IfcxFile

Takes the file out of the document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document