pub struct BufferedSink<Writer = AEADWriter, Buffer = BlockBuffer> { /* private fields */ }
Expand description

Buffered object writer that supports std::io::Write.

Due to performance and storage waste considerations, this will generate a new chunk roughly about every 500kB of the input stream.

You need to take this into account when you want to create the indexes around the stream, as every ChunkPointer is 88 bytes in size, which will occupy memory and storage.

Note that you can’t std::io::Seek in this stream at this point when reading it.

Examples

use std::io::Write;
use infinitree::{*, crypto::UsernamePassword, fields::Serialized, backends::test::InMemoryBackend, object::{Stream, BufferedSink}};

let mut tree = Infinitree::<infinitree::fields::VersionedMap<String, Stream>>::empty(
    InMemoryBackend::shared(),
    UsernamePassword::with_credentials("username".to_string(), "password".to_string()).unwrap()
).unwrap();

let mut sink = BufferedSink::new(tree.storage_writer().unwrap());

sink.write(b"it's going in the sink");
tree.index().insert("message_1".to_string(), sink.finish().unwrap());
tree.commit(None);

Implementations§

source§

impl<W> BufferedSink<W>where W: Writer,

source

pub fn new(writer: W) -> BufferedSink<W>

Create a new BufferedSink with the underlying Writer instance.

source

pub fn with_chunk_size(writer: W, chunk_size: usize) -> Self

Create a new BufferedSink with a custom chunk size

The default chunk size is 500 * 1024 bytes, which experientially is a good trade-off for various stream sizes, as it will minimize storage overhead.

source§

impl<W, Buffer> BufferedSink<W, Buffer>where W: Writer, Buffer: AsMut<[u8]>,

source

pub fn with_buffer(writer: W, buffer: Buffer) -> Result<Self>

Create a new BufferedSink with the underlying Writer and buffer.

source

pub fn set_chunk_size(self, size: usize) -> Result<Self>

Set the maximum size for chunks.

Errors

Will return an error if the underlying buffer is too small.

source

pub fn chunk_size(&self) -> usize

Return the current effective maximum chunk size.

source

pub fn clear(&mut self) -> Result<Stream>

Clear the internal buffer without flushing the underlying Writer.

Calling clear() over finish allows re-using the same buffer and avoids fragmenting data written to storage.

Returns the stream’s descriptor which can be freely serialized or used in an index.

source

pub fn finish(self) -> Result<Stream>

Finish using the BufferedSink instance, flush and close the underlying Writer.

Returns the stream’s descriptor which can be freely serialized or used in an index.

Trait Implementations§

source§

impl<W, Buffer> Write for BufferedSink<W, Buffer>where W: Writer, Buffer: AsMut<[u8]>,

source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written. Read more
source§

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl<Writer, Buffer> RefUnwindSafe for BufferedSink<Writer, Buffer>where Buffer: RefUnwindSafe, Writer: RefUnwindSafe,

§

impl<Writer, Buffer> Send for BufferedSink<Writer, Buffer>where Buffer: Send, Writer: Send,

§

impl<Writer, Buffer> Sync for BufferedSink<Writer, Buffer>where Buffer: Sync, Writer: Sync,

§

impl<Writer, Buffer> Unpin for BufferedSink<Writer, Buffer>where Buffer: Unpin, Writer: Unpin,

§

impl<Writer, Buffer> UnwindSafe for BufferedSink<Writer, Buffer>where Buffer: UnwindSafe, Writer: UnwindSafe,

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

impl<T> FieldWriter for Twhere T: Write + Send,

source§

fn write_next(&mut self, obj: impl Serialize + Send)

Write the next obj into the index
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.

§

impl<T> RmpWrite for Twhere T: Write,

§

type Error = Error

§

fn write_bytes(&mut self, buf: &[u8]) -> Result<(), <T as RmpWrite>::Error>

Write a slice of bytes to the underlying stream Read more
§

fn write_u8(&mut self, val: u8) -> Result<(), Self::Error>

Write a single byte to this stream
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<W> WriteBytesExt for Wwhere W: Write + ?Sized,

§

fn write_u8(&mut self, n: u8) -> Result<(), Error>

Writes an unsigned 8 bit integer to the underlying writer. Read more
§

fn write_i8(&mut self, n: i8) -> Result<(), Error>

Writes a signed 8 bit integer to the underlying writer. Read more
§

fn write_u16<T>(&mut self, n: u16) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 16 bit integer to the underlying writer. Read more
§

fn write_i16<T>(&mut self, n: i16) -> Result<(), Error>where T: ByteOrder,

Writes a signed 16 bit integer to the underlying writer. Read more
§

fn write_u24<T>(&mut self, n: u32) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 24 bit integer to the underlying writer. Read more
§

fn write_i24<T>(&mut self, n: i32) -> Result<(), Error>where T: ByteOrder,

Writes a signed 24 bit integer to the underlying writer. Read more
§

fn write_u32<T>(&mut self, n: u32) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 32 bit integer to the underlying writer. Read more
§

fn write_i32<T>(&mut self, n: i32) -> Result<(), Error>where T: ByteOrder,

Writes a signed 32 bit integer to the underlying writer. Read more
§

fn write_u48<T>(&mut self, n: u64) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 48 bit integer to the underlying writer. Read more
§

fn write_i48<T>(&mut self, n: i64) -> Result<(), Error>where T: ByteOrder,

Writes a signed 48 bit integer to the underlying writer. Read more
§

fn write_u64<T>(&mut self, n: u64) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 64 bit integer to the underlying writer. Read more
§

fn write_i64<T>(&mut self, n: i64) -> Result<(), Error>where T: ByteOrder,

Writes a signed 64 bit integer to the underlying writer. Read more
§

fn write_u128<T>(&mut self, n: u128) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned 128 bit integer to the underlying writer.
§

fn write_i128<T>(&mut self, n: i128) -> Result<(), Error>where T: ByteOrder,

Writes a signed 128 bit integer to the underlying writer.
§

fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned n-bytes integer to the underlying writer. Read more
§

fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

Writes a signed n-bytes integer to the underlying writer. Read more
§

fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

Writes an unsigned n-bytes integer to the underlying writer. Read more
§

fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error>where T: ByteOrder,

Writes a signed n-bytes integer to the underlying writer. Read more
§

fn write_f32<T>(&mut self, n: f32) -> Result<(), Error>where T: ByteOrder,

Writes a IEEE754 single-precision (4 bytes) floating point number to the underlying writer. Read more
§

fn write_f64<T>(&mut self, n: f64) -> Result<(), Error>where T: ByteOrder,

Writes a IEEE754 double-precision (8 bytes) floating point number to the underlying writer. Read more
source§

impl<T> Transaction for Twhere T: Send + Sync + Write,