Struct fog_pack::document::AsyncVecDocumentBuilder

pub struct AsyncVecDocumentBuilder<St> where
    St: Stream,
    St::Item: Serialize,  { /* fields omitted */ }

An stream adapter for building many Documents.

Frequently, fog-pack’s 1 MiB size limit can pose problems with large data sets. Generally, these data sets can be treated as large arrays of relatively small data objects. This adaptor can take a stream over any set of data objects, and will produce a series of Documents that are under the size limit.

For the synchronous version that works on iterators, see AsyncVecDocumentBuilder.

Implementations

impl<St> AsyncVecDocumentBuilder<St> where
    St: Stream,
    St::Item: Serialize, 

pub fn new(stream: St, schema: Option<&Hash>) -> Self

pub fn new_ordered(stream: St, schema: Option<&Hash>) -> Self

pub fn compression(self, setting: Option<u8>) -> Self

Override the default compression settings for all produced Documents. None will disable compression. Some(level) will compress with the provided level as the setting for the algorithm.

pub fn sign(self, key: &IdentityKey) -> Self

Sign the all produced documents from this point onward.

Trait Implementations

impl<St> Debug for AsyncVecDocumentBuilder<St> where
    St: Stream + Debug,
    St::Item: Serialize + Debug, 

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

Formats the value using the given formatter.

impl<St> FusedStream for AsyncVecDocumentBuilder<St> where
    St: Stream + FusedStream,
    St::Item: Serialize, 

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<St> Stream for AsyncVecDocumentBuilder<St> where
    St: Stream,
    St::Item: Serialize, 

type Item = Result<NewDocument>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Result<NewDocument>>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, St> Unpin for AsyncVecDocumentBuilder<St> where
    __Origin<'__pin, St>: Unpin,
    St: Stream,
    St::Item: Serialize,