Struct btlib::BlockMetaBody

source ·
pub struct BlockMetaBody { /* private fields */ }
Expand description

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§

source§

impl BlockMetaBody

source

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.

source

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.

source

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

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

source

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

Returns a reference to the block key.

source

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

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

source

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.

source

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.

source

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

Adds a new readcap for the given Creds.

source

pub fn path(&self) -> &BlockPath

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

source

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

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

Trait Implementations§

source§

impl AsMut<BlockMetaBody> for BlockMeta

source§

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

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

impl AsRef<BlockMetaBody> for BlockMeta

source§

fn as_ref(&self) -> &BlockMetaBody

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

impl Clone for BlockMetaBody

source§

fn clone(&self) -> BlockMetaBody

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BlockMetaBody

source§

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

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

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

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<BlockMetaBody> for BlockMetaBody

source§

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

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

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.
source§

impl Serialize for BlockMetaBody

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 BlockMetaBody

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Free for T

§

unsafe default fn free(ptr_ref: NonNull<T>)

Drops the content pointed by this pointer and frees it. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.
source§

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