Skip to main content

StructureReport

Struct StructureReport 

Source
#[non_exhaustive]
pub struct StructureReport { pub cfb_version: u16, pub storages: u32, pub red_black_trees: u32, pub top_down_trees: u32, pub irregular_free_entries: u32, pub writer_slot_order: bool, pub pages: u32, pub pages_with_number_or_population: u32, pub model_records_without_time: u32, pub split_dictionary_pages: Vec<u32>, pub warnings: Vec<Warning>, }
Expand description

Structural facts of a DGN V8 file’s container and pages.

The report states what the file holds; it does not claim that any application accepts the file. Counts that differ between observed writers (the page header’s number and population, the directory slot order) are information, not warnings. Recoverable problems are listed in warnings with stable codes:

CodeMeaning
dgn.cfb_tree_unordereda sibling tree is not ordered by CFB name ([MS-CFB] 2.6.4), reaches a slot twice or points outside the directory: lookups by name can miss entries
dgn.cfb_tree_unbalanceda sibling tree is ordered, but its colours are not a red-black tree (MS-CFB permits this, an all-black tree for instance)
dgn.cfb_tree_shareda storage’s sibling tree reaches entries an earlier storage’s tree holds (an entry with two parents, which [MS-CFB] does not allow); the tree is counted in storages but not analysed
dgn.cfb_free_entrya slot the root does not reach is not in the free form of [MS-CFB] 2.6.3
dgn.record_timea graphic or control record has no positive finite time at +0x18
dgn.dictionary_page_splita Dgn^Nm page starts with a complex component
dgn.model_page_counterthe first dword of a model header stream lies outside [pages holding records, pages] of its graphic and control pages

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§cfb_version: u16

Compound file major version (3: 512-byte sectors, 4: 4096-byte sectors).

§storages: u32

Storages, the root included, whose child (sibling) tree is not empty.

§red_black_trees: u32

Of storages, the trees that are ordered red-black trees: colours 0 or 1, a black tree root, no red node with a red child and the same number of black nodes on every path.

§top_down_trees: u32

Of storages, the trees whose shape equals top-down 2-3-4 red-black insertion of the children in slot order, the shape the writer produces.

§irregular_free_entries: u32

Directory slots the root does not reach that are not in the MS-CFB free form.

§writer_slot_order: bool

Whether the reachable entries fill slots 1, 2, … without a gap in the order the writer uses. That order is one seed lineage’s; observed files differ, and readers find entries through the sibling trees, not by slot.

§pages: u32

Page streams ($n) of every model’s graphic, control and auxiliary storages and of Dgn^Nm / Dgn^NmA.

§pages_with_number_or_population: u32

Of pages, those whose header stores a page number or population (+0x08 / +0x0C) other than 0. Public files written by other applications store both; this is not a defect.

§model_records_without_time: u32

Graphic and control records whose time (f64 at +0x18, milliseconds since 1970) is not positive and finite.

§split_dictionary_pages: Vec<u32>

Numbers of the Dgn^Nm pages that start with a complex component.

§warnings: Vec<Warning>

Recoverable problems, see the table above.

Implementations§

Source§

impl StructureReport

Source

pub fn is_clean(&self) -> bool

Whether the report holds no warning.

Trait Implementations§

Source§

impl Clone for StructureReport

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StructureReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StructureReport

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StructureReport

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for StructureReport

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for StructureReport

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StructureReport

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.