Reference index

file format 6
Rust SDK 1.0 preview

The Rust SDK is one crate, plxi-sdk, imported as plxi_sdk. Its JSON type is serde_json::Value. This reference lists every public item, generated from the crate.

On this page, Result<T> is std::result::Result<T, plxi_sdk::Error>.

**Table 1.** Reference pages (11 rows)
Page	Items
Pack	`OpenOptions`, `Pack`
Records	`Record`, `EntityView`, `RelationView`
Filter	`Filter`
Write	`write`, `write_to_path`, `AppendixSpec`
Appendix	`Appendix`, `SectionInfo`, `BoundEmbedding`, `BindProfile`, `COMPACT_RECORD_SIZE`, `COMPACT_FORMAT_VERSION`, `COMPACT_ALIGN_LOG2`
Verify	`Pack::verify`, `Pack::bind_embrefs`, `RecordCountReport`, `SectionCrcReport`, `AppendixReport`, `EmbrefReport`, `VerifyReport`
Merge	`merge`, `MergeOptions`, `MergeReport`, `MergeStrategy`
Diff	`diff`, `DiffChange`, `AppendixDiff`, `Diff`
Canonical JSON	`canonical_json`
Errors	`Error`, `ErrorKind`, `Result`
Constants and versions	`sdk_version`, `corpus_version`, `error_kinds_version`, `FORMAT_VERSION`

Pack is Send and Sync: one opened pack can be read from several threads.

A fault inside the SDK is returned as an error of kind internal, and the calling process keeps running, when your program is built with panic = "unwind", which is Cargo's default. A program built with panic = "abort" stops at the fault instead.

Figure 1 From bytes to records and back

A pack is opened from a file or from bytes. Its verify report, appendix, differences and records are read from the opened Pack, and write turns records back into bytes. Table 2 lists the same calls.

**Table 2.** Calls in Figure 1 (7 rows)
Call	From	To
`Pack::open`	a file path	`Pack`
`Pack::from_bytes`	`Vec<u8>`	`Pack`
`Pack::verify`	`Pack`	`VerifyReport`
`Pack::appendix`	`Pack`	`Appendix`
`diff`	`Pack`	`Diff`
`Pack::records`	`Pack`	`Record`
`write`	`Record`	`Vec<u8>`

Anyone may implement this format. Copying or republishing the text of this specification requires permission from Cintile Inc.