Struct fog_pack::document::NewDocument

pub struct NewDocument(_);

A new Document that has not yet been validated.

This struct acts like a Document, but cannot be decoded until it has passed through either a Schema or through NoSchema.

Implementations

impl NewDocument

pub fn new<S: Serialize>(data: S, schema: Option<&Hash>) -> Result<Self>

Create a new Entry from any serializable data, a key, and the Hash of the parent document.

pub fn new_ordered<S: Serialize>(data: S, schema: Option<&Hash>) -> Result<Self>

Create a new Entry from any serializable data whose keys are all ordered. For structs, this means all fields are declared in lexicographic order. For maps, this means a BTreeMap type must be used, whose keys are ordered such that they serialize to lexicographically ordered strings. All sub-structs and sub-maps must be similarly ordered.

pub fn schema_hash(&self) -> Option<&Hash>

Get the hash of the schema this document adheres to.

pub fn compression(self, setting: Option<u8>) -> Self

Override the default compression settings. None will disable compression. Some(level) will compress with the provided level as the setting for the algorithm.

pub fn sign(self, key: &IdentityKey) -> Result<Self>

Sign the document, or or replace the existing signature if one exists already. Fails if the signature would grow the document size beyond the maximum allowed. In the event of a failure, the document is dropped.

pub fn hash(&self) -> Hash

Get what the document’s hash will be, given its current state

Trait Implementations

impl Clone for NewDocument

fn clone(&self) -> NewDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NewDocument

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

Formats the value using the given formatter.