Struct WatchedEvent

#[non_exhaustive]
pub struct WatchedEvent {
    pub event_type: EventType,
    pub session_state: SessionState,
    pub path: String,
    pub zxid: i64,
}

WatchedEvent represents update to watched node or session.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

event_type: EventType

session_state: SessionState

Updated state for state event. No meaning in node events.

Caution

There will be no more updates after terminal session state.

path: String

Node path from chroot. Empty if this is a state event.

zxid: i64

zxid of the transaction that triggered this node event, WatchedEvent::NO_ZXID for session event.

Notable behaviors

• This feature was shipped in 3.9.0, zxid wil be WatchedEvent::NO_ZXID for earlier versions. See ZOOKEEPER-4655.
• It is possible to receive multiple events with same zxid and even same path due to crate::MultiWriter. See ZOOKEEPER-4695.

Implementations

impl WatchedEvent

pub const NO_ZXID: i64 = -1i64

pub fn new(event: EventType, path: impl Into<String>) -> Self

pub fn with_zxid(self, zxid: i64) -> Self

pub fn new_session(state: SessionState) -> Self

Trait Implementations

impl Clone for WatchedEvent

fn clone(&self) -> WatchedEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WatchedEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WatchedEvent

fn eq(&self, other: &WatchedEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WatchedEvent

impl StructuralPartialEq for WatchedEvent