Struct RestStream 

pub struct RestStream { /* private fields */ }

A configured REST API stream that handles pagination, auth, and extraction.

Implementations

impl RestStream

pub fn new(config: RestStreamConfig) -> Result<Self, FaucetError>

Create a new stream from the given configuration.

pub async fn fetch_all(&self) -> Result<Vec<Value>, FaucetError>

Fetch all records across all pages as raw JSON values.

pub async fn fetch_all_as<T: for<'de> Deserialize<'de>>( &self, ) -> Result<Vec<T>, FaucetError>

Fetch all records and deserialize into typed structs.

pub fn stream_pages( &self, ) -> Pin<Box<dyn Stream<Item = Result<Vec<Value>, FaucetError>> + '_>>

Stream records page-by-page, yielding one Vec<Value> per page as it arrives.

Unlike fetch_all, this does not wait for all pages to be fetched before returning — callers can process each page immediately.

use faucet_stream::{RestStream, RestStreamConfig};
use futures::StreamExt;

let stream = RestStream::new(RestStreamConfig::new("https://api.example.com", "/items"))?;
let mut pages = stream.stream_pages();
while let Some(page) = pages.next().await {
    let records = page?;
    println!("got {} records", records.len());
}