stream-download is a library for streaming content from a remote location to a local cache and using it as a read and seek-able source. The requested content is downloaded in the background and read or seek operations are allowed before the download is finished. Seek operations may cause the stream to be restarted from the requested position if the download is still in progress. This is useful for media applications that need to stream large files that may take a long time to download.
HTTP is the only transport supplied by this library, but you can use a custom transport by implementing the SourceStream trait.
sh
cargo add stream-download
http - adds an HTTP-based implementation of the SourceStream trait (enabled by default).reqwest - enables streaming content over http using reqwest (enabled by default).reqwest-native-tls - enables reqwest's native-tls feature. Also enables the reqwest feature.reqwest-rustls - enables reqwest's rustls feature. Also enables the reqwest feature.temp-storage - adds a temporary file-based storage backend (enabled by default).One of reqwest-native-tls or reqwest-rustls is required if you wish to use https streams.
```rust,no_run use std::error::Error; use std::io::Read; use std::result::Result;
use streamdownload::storage::temp::TempStorageProvider; use streamdownload::{Settings, StreamDownload};
async fn main() -> Result<(), Box
let mut buf = Vec::new();
reader.read_to_end(&mut buf)?;
Ok(())
}
```
See examples.
Resources such as standalone songs or videos have a finite length that we use to support certain seeking functionality. Infinite streams or those that otherwise don't have a known length are still supported, but attempting to seek from the end of the stream will return an error. This may cause issues with certain audio or video libraries that attempt to perform such seek operations. If it's necessary to explicitly check for an infinite stream, you can check the stream's content length ahead of time.
```rust,no_run use std::error::Error; use std::io::Read; use std::result::Result;
use streamdownload::http::HttpStream; use streamdownload::http::reqwest::Client; use streamdownload::source::SourceStream; use streamdownload::storage::temp::TempStorageProvider; use stream_download::{Settings, StreamDownload};
async fn main() -> Result<(), Box
let mut reader =
StreamDownload::from_stream(stream, TempStorageProvider::default(), Settings::default())
.await?;
let mut buf = [0; 256];
reader.read_exact(&mut buf)?;
Ok(())
} ```
The storage module provides ways to customize how the stream is cached locally. Pre-configured implementations are available for memory and temporary file-based storage. Typically you'll want to use temporary file-based storage to prevent using too much memory, but memory-based storage may be preferable if you know the stream size is small or you need to run your application on a read-only filesystem.
```rust,no_run use std::error::Error; use std::io::Read; use std::result::Result;
use streamdownload::storage::memory::MemoryStorageProvider; use streamdownload::{Settings, StreamDownload};
async fn main() -> Result<(), Box
Ok(())
} ```
When using infinite streams which don't need to support seeking, it usually isn't desirable to let the underlying cache grow indefinitely if the stream may be running for a while. For these cases, you may want to use bounded storage. Bounded storage uses a circular buffer which will overwrite the oldest contents once it fills up.
```rust,no_run use std::error::Error; use std::io::Read; use std::num::NonZeroUsize; use std::result::Result;
use streamdownload::storage::bounded::BoundedStorageProvider; use streamdownload::storage::memory::MemoryStorageProvider; use stream_download::{Settings, StreamDownload};
async fn main() -> Result<(), Box
Ok(())
} ```
When you need to support both finite and infinite streams, you may want to use adaptive storage. This is a convenience wrapper that will use bounded storage when the stream has no content length and unbounded storage when the stream does return a content length.
```rust,no_run use std::error::Error; use std::io::Read; use std::num::NonZeroUsize; use std::result::Result;
use streamdownload::storage::adaptive::AdaptiveStorageProvider; use streamdownload::storage::temp::TempStorageProvider; use stream_download::{Settings, StreamDownload};
async fn main() -> Result<(), Box
Ok(())
} ```
The MSRV is currently 1.63.0.