1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! Library to make working with streams a bit less painful.
use std::io;

use bytes::Bytes;
use futures::Stream;

pub mod fs;
pub mod util;

/// A boxed stream of [`Bytes`] that can be unpinned.
///
/// [`Bytes`]: bytes::Bytes
pub type UnpinDynIOStream =
    Box<dyn Stream<Item = Result<Bytes, io::Error>> + Send + Sync + Unpin + 'static>;

/// A boxed stream of [`Bytes`].
///
/// [`Bytes`]: bytes::Bytes
pub type DynIOStream = Box<dyn Stream<Item = Result<Bytes, io::Error>> + Send + Sync + 'static>;

/// A stream that can be part of a larger file.
pub struct ChunkedStreamInfo {
    /// The stream data.
    pub stream: DynIOStream,

    /// The size of the current stream chunk, in bytes.
    pub chunk_size: u64,

    /// The total size of the file the stream was extracted from, in bytes.
    pub total_size: u64,
}