Struct Rss2FeedStream 

pub struct Rss2FeedStream { /* private fields */ }

Available on crate features http and rss only.

Async streaming reader for an RSS 2.0 feed.

Construction reads the document up to (but not including) the first <item>, so the parsed Rss2Channel is available immediately via channel. The stream then yields one Rss2Item per channel item until the document ends.

The stream itself implements Stream<Item = Result<Rss2Item, _>>, so the usual combinators work; or you can split with drain, collect with collect / collect_lossy, or filter while collecting via collect_filtered.

Implementations

impl Rss2FeedStream

pub async fn new<R>(reader: R) -> Result<Rss2FeedStream, FeedParseError>

where R: AsyncBufRead + Unpin + Send + 'static,

Build the stream over reader in lenient mode (unknown elements skipped, recoverable text issues tolerated).

pub async fn new_strict<R>(reader: R) -> Result<Rss2FeedStream, FeedParseError>

where R: AsyncBufRead + Unpin + Send + 'static,

Strict variant — structural violations propagate as Err.

pub fn channel(&self) -> &Rss2Channel

Borrow the channel-level metadata parsed at construction time.

pub fn drain( self, ) -> (Rss2Channel, Pin<Box<dyn Stream<Item = Result<Rss2Item, FeedParseError>> + Send>>)

Split into (channel, items) so the caller can map/filter/fold over the items without giving up the channel.

pub async fn collect(self) -> Result<Rss2Feed, CollectError<Rss2Feed>>

Drain the stream into a complete in-memory Rss2Feed. On a per-item parse error, the returned Rss2CollectError carries every item successfully parsed so far together with the channel header.

pub async fn collect_lossy(self) -> Rss2Feed

Drain the stream, dropping individual items that fail to parse and returning only the successful ones. Errors are logged at tracing::debug!; the function itself is infallible because the header was already parsed at construction time.

pub async fn collect_filtered<F>( self, predicate: F, ) -> Result<Rss2Feed, CollectError<Rss2Feed>>

where F: FnMut(&Rss2Item) -> bool + Send,

Drain the stream into a feed, retaining only items for which the predicate returns true. Per-item parse errors short-circuit with a partial feed, identical to collect.

Trait Implementations

impl Stream for Rss2FeedStream

type Item = Result<Rss2Item, FeedParseError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Rss2FeedStream>, cx: &mut Context<'_>, ) -> Poll<Option<<Rss2FeedStream as Stream>::Item>>

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.