Struct btlib::BlockMetaBody

pub struct BlockMetaBody { /* private fields */ }

This struct contains all of the metadata fields associated with a block, except for its signature. Since this struct implements Serialize, this allows for convenient signature calculations.

Implementations

impl BlockMetaBody

pub fn unlock_block_key_with_parent_key( &mut self, parent_key: SymKey ) -> Result<()>

Uses the given symmetric key to decrypt the inherit field. If this field is None, or if the decryption fails, then an error is returned. If the block key has already been decrypted then this method does nothing.

pub fn access_secrets<T, F: FnOnce(&mut BlockMetaSecrets) -> Result<T>>( &mut self, accessor: F ) -> Result<T>

The given closure is called with the BlockMetaSecrets contained in this struct. Whatever the closure returns is returned by this method (unless an error occurs). The secrets are decrypted, if needed, and after the closure returns they are updated. It’s best to use the BlockMetaBody::secrets method if all you need is read access.

pub fn secrets(&self) -> Result<&BlockMetaSecrets>

Returns a reference to the secrets in this struct. This is very cheap operation, just copying a reference.

pub fn block_key(&self) -> Result<&SymKey>

Returns a reference to the block key.

pub fn block_id(&self) -> Result<&BlockId>

Returns the ID of the block this metadata is part of.

pub fn integrity(&self) -> Option<&[u8]>

Returns a reference to the integrity value stored in this struct. This value represents the authenticated value of the block’s contents.

pub fn use_readcap_for<C: Creds>(&mut self, creds: &C) -> Result<&SymKey>

Decrypts the readcap for the given Creds and uses the resulting plaintext as the block key.

pub fn add_readcap_for<C: CredsPub>(&mut self, creds: C) -> Result<()>

Adds a new readcap for the given Creds.

pub fn path(&self) -> &BlockPath

Returns a reference to the BlockPath of the block this metadata is for.

pub fn path_mut(&mut self) -> &mut BlockPath

Returns a mutable reference to the BlockPath of the block this metadata is for.

Trait Implementations

impl AsMut<BlockMetaBody> for BlockMeta

fn as_mut(&mut self) -> &mut BlockMetaBody

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<BlockMetaBody> for BlockMeta

fn as_ref(&self) -> &BlockMetaBody

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BlockMetaBody

fn clone(&self) -> BlockMetaBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockMetaBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockMetaBody

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<BlockMetaBody> for BlockMetaBody

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BlockMetaBody

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BlockMetaBody