Struct fog_pack::entry::Entry

pub struct Entry { /* fields omitted */ }

Holds serialized data associated with a parent document and a key string.

An Entry holds a piece of serialized data, which may be deserialized by calling deserialize.

Implementations

impl Entry

pub fn parent(&self) -> &Hash

Get the hash of the Entry’s parent Document.

pub fn key(&self) -> &str

Get the Entry’s string key.

pub fn signer(&self) -> Option<&Identity>

Get the Identity of the signer of this document, if the document is signed.

pub fn hash(&self) -> Hash

Get the hash of the complete entry. This can change if the entry is signed again with the sign function.

pub fn deserialize<'de, D: Deserialize<'de>>(&'de self) -> Result<D>

Deserialize the entry’s contained data into a value.

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 entry, or or replace the existing signature if one exists already. Fails if the signature would grow the entry size beyond the maximum allowed. In the event of a failure. the entry is unmodified.