pub struct AlloySubscriber<P, N: Network = Ethereum> { /* private fields */ }Expand description
Alloy-backed event subscriber.
The default transport slice drives Alloy pubsub subscriptions for logs,
block headers, and pending transaction hashes. The HTTP polling watch_*
transport remains available behind the opt-in reactive-polling feature.
Pubsub streams reconnect automatically after termination, and log
subscriptions are backfilled from the last seen block. Owner-scoped log
additions can request backfill from an explicit block anchor. Full pending
transaction hydration and full block bodies remain explicit follow-up work.
With no registered interests, EventSubscriber::next_batch returns
Ok(None).
Implementations§
Source§impl<P, N: Network> AlloySubscriber<P, N>
impl<P, N: Network> AlloySubscriber<P, N>
Sourcepub fn new(provider: P, mode: SubscriberMode, config: SubscriberConfig) -> Self
pub fn new(provider: P, mode: SubscriberMode, config: SubscriberConfig) -> Self
Create a new Alloy subscriber.
Sourcepub fn mode(&self) -> SubscriberMode
pub fn mode(&self) -> SubscriberMode
Subscriber mode.
Sourcepub fn config(&self) -> &SubscriberConfig
pub fn config(&self) -> &SubscriberConfig
Subscriber config.
Sourcepub fn registered_interests(&self) -> &[ReactiveInterest<N>]
pub fn registered_interests(&self) -> &[ReactiveInterest<N>]
Registered interests across base and owner-scoped registrations.
Sourcepub fn add_interest_owner(
&mut self,
owner: HandlerId,
interests: &[ReactiveInterest<N>],
) -> Result<(), SubscriberError>
pub fn add_interest_owner( &mut self, owner: HandlerId, interests: &[ReactiveInterest<N>], ) -> Result<(), SubscriberError>
Add or replace the interests owned by owner.
This preserves unrelated owners, queued/pending records, recent dedupe
state, and last-seen log anchors. The live transport is reconciled on the
next EventSubscriber::next_batch call so newly added log filters can
be subscribed without rebuilding the whole subscriber object.
Replacing an existing owner is continuity-safe: filters the owner
already had keep their delivery anchors, and any changed or new filter
shape is automatically backfilled from the owner’s oldest prior anchor —
growing a pool set on an established owner does not open a delivery gap
for what the old subscription had already covered. A brand-new owner has
no anchor to inherit; pass an explicit
add_interest_owner_with_backfill
anchor (or register through ReactiveEngine::register_handler, which
anchors to the runtime’s last canonical block).
Sourcepub fn add_interest_owner_with_backfill(
&mut self,
owner: HandlerId,
interests: &[ReactiveInterest<N>],
backfill: SubscriberBackfill,
) -> Result<(), SubscriberError>
pub fn add_interest_owner_with_backfill( &mut self, owner: HandlerId, interests: &[ReactiveInterest<N>], backfill: SubscriberBackfill, ) -> Result<(), SubscriberError>
Add or replace owner interests and schedule log backfill for that owner.
Backfill is queued only for log interests; block and pending transaction
interests are live-only. Queued backfill is drained before live stream
initialization, its resolved upper bound seeds the filter’s delivery
anchor, and the anchored filter is caught up again right after its live
stream connects — so the discovery boundary is closed end to end as long
as backfill starts at (or before) the block the interest was
discovered in. Continuity backfill for a replaced owner (see
add_interest_owner) is queued in addition,
unless this explicit backfill is open-ended and already starts at or
below the owner’s prior anchor.
Sourcepub fn remove_interest_owner(
&mut self,
owner: &HandlerId,
) -> Option<Vec<ReactiveInterest<N>>>
pub fn remove_interest_owner( &mut self, owner: &HandlerId, ) -> Option<Vec<ReactiveInterest<N>>>
Remove one owner’s interests, preserving unrelated owner/base interests.
The owner’s queued backfills are dropped, and source-id/anchor
bookkeeping for filters no other owner references is retired. Live
streams for retired filters are torn down on the next
EventSubscriber::next_batch call (dropping an Alloy subscription
unsubscribes provider-side); events already in flight from them stop
matching the merged interest set and are discarded.
Sourcepub fn owner_interests(
&self,
owner: &HandlerId,
) -> Option<&[ReactiveInterest<N>]>
pub fn owner_interests( &self, owner: &HandlerId, ) -> Option<&[ReactiveInterest<N>]>
Borrow the interests currently owned by owner.
Trait Implementations§
Source§impl<P, N> EventSubscriber<N> for AlloySubscriber<P, N>
impl<P, N> EventSubscriber<N> for AlloySubscriber<P, N>
Source§fn register_interests(
&mut self,
interests: &[ReactiveInterest<N>],
) -> Result<(), SubscriberError>
fn register_interests( &mut self, interests: &[ReactiveInterest<N>], ) -> Result<(), SubscriberError>
Source§fn next_batch(&mut self) -> SubscriberNextBatch<'_, N>
fn next_batch(&mut self) -> SubscriberNextBatch<'_, N>
Ok(None) when the stream is exhausted.Source§impl<P, N> InterestOwnerSubscriber<N> for AlloySubscriber<P, N>
impl<P, N> InterestOwnerSubscriber<N> for AlloySubscriber<P, N>
Source§fn add_interest_owner(
&mut self,
owner: HandlerId,
interests: &[ReactiveInterest<N>],
) -> Result<(), SubscriberError>
fn add_interest_owner( &mut self, owner: HandlerId, interests: &[ReactiveInterest<N>], ) -> Result<(), SubscriberError>
owner.Source§fn add_interest_owner_with_backfill(
&mut self,
owner: HandlerId,
interests: &[ReactiveInterest<N>],
backfill: SubscriberBackfill,
) -> Result<(), SubscriberError>
fn add_interest_owner_with_backfill( &mut self, owner: HandlerId, interests: &[ReactiveInterest<N>], backfill: SubscriberBackfill, ) -> Result<(), SubscriberError>
Source§fn remove_interest_owner(
&mut self,
owner: &HandlerId,
) -> Option<Vec<ReactiveInterest<N>>>
fn remove_interest_owner( &mut self, owner: &HandlerId, ) -> Option<Vec<ReactiveInterest<N>>>
Source§fn owner_interests(&self, owner: &HandlerId) -> Option<&[ReactiveInterest<N>]>
fn owner_interests(&self, owner: &HandlerId) -> Option<&[ReactiveInterest<N>]>
owner.Auto Trait Implementations§
impl<P, N = Ethereum> !RefUnwindSafe for AlloySubscriber<P, N>
impl<P, N = Ethereum> !Sync for AlloySubscriber<P, N>
impl<P, N = Ethereum> !UnwindSafe for AlloySubscriber<P, N>
impl<P, N> Freeze for AlloySubscriber<P, N>where
P: Freeze,
impl<P, N> Send for AlloySubscriber<P, N>where
P: Send,
impl<P, N> Unpin for AlloySubscriber<P, N>
impl<P, N> UnsafeUnpin for AlloySubscriber<P, N>where
P: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.