Struct hypercore::Storage [−][src]
pub struct Storage<T> where
T: RandomAccessMethods + Debug, { /* fields omitted */ }Save data to a desired storage backend.
Methods
impl<T> Storage<T> where
T: RandomAccessMethods + Debug, [src]
impl<T> Storage<T> where
T: RandomAccessMethods + Debug, pub fn new<Cb>(create: Cb) -> Result<Self> where
Cb: Fn(Store) -> RandomAccess<T>, [src]
pub fn new<Cb>(create: Cb) -> Result<Self> where
Cb: Fn(Store) -> RandomAccess<T>, Create a new instance. Takes a keypair and a callback to create new storage instances.
pub fn write_data(&mut self, offset: usize, data: &[u8]) -> Result<()>[src]
pub fn write_data(&mut self, offset: usize, data: &[u8]) -> Result<()>Write data to the feed.
pub fn put_data(
&mut self,
index: usize,
data: &[u8],
nodes: &[Node]
) -> Result<()>[src]
pub fn put_data(
&mut self,
index: usize,
data: &[u8],
nodes: &[Node]
) -> Result<()>Write a byte vector to a data storage (random-access instance) at the
position of index.
NOTE: Meant to be called from the .put() feed method. Probably used to
insert data as-is after receiving it from the network (need to confirm
with mafintosh).
TODO: Ensure the signature size is correct.
NOTE: Should we create a Data entry type?
pub fn get_data(&mut self, index: usize) -> Result<Vec<u8>>[src]
pub fn get_data(&mut self, index: usize) -> Result<Vec<u8>>Get data from disk that the user has written to it. This is stored unencrypted, so there's no decryption needed.
pub fn next_signature(&mut self, index: usize) -> Result<Signature>[src]
pub fn next_signature(&mut self, index: usize) -> Result<Signature>Search the signature stores for a Signature, starting at index.
pub fn get_signature(&mut self, index: usize) -> Result<Signature>[src]
pub fn get_signature(&mut self, index: usize) -> Result<Signature>Get a Signature from the store.
pub fn put_signature(
&mut self,
index: usize,
signature: impl Borrow<Signature>
) -> Result<()>[src]
pub fn put_signature(
&mut self,
index: usize,
signature: impl Borrow<Signature>
) -> Result<()>Write a Signature to self.Signatures.
TODO: Ensure the signature size is correct.
NOTE: Should we create a Signature entry type?
pub fn data_offset(
&mut self,
index: usize,
cached_nodes: &[Node]
) -> Result<Range<usize>>[src]
pub fn data_offset(
&mut self,
index: usize,
cached_nodes: &[Node]
) -> Result<Range<usize>>TODO(yw) docs
Get the offset for the data, return (offset, size).
Panics
A panic can occur if no maximum value is found.
pub fn get_node(&mut self, index: usize) -> Result<Node>[src]
pub fn get_node(&mut self, index: usize) -> Result<Node>Get a Node from the tree storage.
pub fn put_node(&mut self, node: &Node) -> Result<()>[src]
pub fn put_node(&mut self, node: &Node) -> Result<()>Write a Node to the tree storage.
TODO: prevent extra allocs here. Implement a method on node that can reuse
a buffer.
pub fn put_bitfield(&mut self, offset: usize, data: &[u8]) -> Result<()>[src]
pub fn put_bitfield(&mut self, offset: usize, data: &[u8]) -> Result<()>Write data to the internal bitfield module. TODO: Ensure the chunk size is correct. NOTE: Should we create a bitfield entry type?
pub fn open_key(&mut self)[src]
pub fn open_key(&mut self)TODO(yw) docs
impl Storage<RandomAccessMemoryMethods>[src]
impl Storage<RandomAccessMemoryMethods>pub fn new_memory() -> Result<Self>[src]
pub fn new_memory() -> Result<Self>impl Storage<RandomAccessDiskMethods>[src]
impl Storage<RandomAccessDiskMethods>