Struct btlib::BlockOpenOptions

pub struct BlockOpenOptions<T, C> { /* private fields */ }

Describes how to open a block, including the inner stream from which the block can be read and the credentials to use to open it.

Implementations

impl BlockOpenOptions<(), ()>

pub fn new() -> BlockOpenOptions<(), ()>

Creates a new empty BlockOpenOptions.

impl<T, C> BlockOpenOptions<T, C>

pub fn with_inner<U>(self, inner: U) -> BlockOpenOptions<U, C>

Configures the given stream to be used for reading and writing the block.

pub fn with_creds<D>(self, creds: D) -> BlockOpenOptions<T, D>

Configures the given Creds to be used to open the block.

pub fn with_encrypt(self, encrypt: bool) -> Self

Specifies whether or not the block contents will be encrypted.

pub fn with_block_path(self, block_path: BlockPath) -> Self

Specifies the path of the block. If the block is new, this will be the path it’s created at. If an existing block is being opened, then this is used for validating the block.

pub fn with_parent_key(self, parent_key: Option<SymKey>) -> Self

Configures the given parent key to be used for unlocking the block key.

impl<T: ReadAt + WriteAt + Size + Sectored + 'static, C: Creds + 'static> BlockOpenOptions<T, C>

pub fn open_bare(self) -> Result<ConcreteBlock<T, C>>

Opens the block without wrapping it in an Accessor.

pub fn open(self) -> Result<Accessor<ConcreteBlock<T, C>>>

Opens the block and wraps it in an Accessor before returning it.

Trait Implementations

impl Default for BlockOpenOptions<(), ()>

fn default() -> Self

Returns the “default value” for a type.