File tree Expand file tree Collapse file tree 2 files changed +9
-6
lines changed
Expand file tree Collapse file tree 2 files changed +9
-6
lines changed Original file line number Diff line number Diff line change 1717//!
1818//! ## Backpressure and lag
1919//!
20- //! Subscription streams are buffered. If a consumer cannot keep up and the internal broadcast
21- //! channel drops messages, the corresponding subscription yields [`ScannerError::Lagged`].
20+ //! Subscription streams are buffered. If a consumer processes events too slowly and the
21+ //! internal buffer fills up, the stream yields [`ScannerError::Lagged`] and some events
22+ //! may be skipped.
2223//!
2324//! # Reorgs and finality
2425//!
Original file line number Diff line number Diff line change 1- //! Event-Scanner is a Rust library for streaming EVM event logs.
1+ //! Event-Scanner is a library made to stream EVM event logs.
22//!
3- //! The main entry point is [`EventScanner`], configured via [`EventScannerBuilder`] in one of the
4- //! supported modes (for example [`Historic`] or [`Live`]). Consumers register one or more event
5- //! subscriptions via [`EventScanner::subscribe`] and then start the scanner.
3+ //! The main entry point is [`EventScanner`], built via [`EventScannerBuilder`] in one of the
4+ //! supported modes (e.g. [`Historic`] or [`Live`]).
5+ //!
6+ //! After constructing a scanner, register one or more event subscriptions with
7+ //! [`EventScanner::subscribe`], then call [`EventScanner::start`] to begin streaming.
68//!
79//! # Stream items
810//!
You can’t perform that action at this time.
0 commit comments