Struct postgres::notifications::Notifications
source · pub struct Notifications<'a> { /* private fields */ }
Expand description
Notifications from a PostgreSQL backend.
Implementations§
source§impl<'a> Notifications<'a>
impl<'a> Notifications<'a>
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Determines if there are any already buffered pending notifications.
sourcepub fn iter(&mut self) -> Iter<'_>
pub fn iter(&mut self) -> Iter<'_>
Returns a nonblocking iterator over notifications.
If there are no already buffered pending notifications, this iterator will poll the connection but will not
block waiting on notifications over the network. A return value of None
either indicates that there are no
pending notifications or that the server has disconnected.
§Note
This iterator may start returning Some
after previously returning None
if more notifications are received.
sourcepub fn blocking_iter(&mut self) -> BlockingIter<'_>
pub fn blocking_iter(&mut self) -> BlockingIter<'_>
Returns a blocking iterator over notifications.
If there are no already buffered pending notifications, this iterator will block indefinitely waiting on the
PostgreSQL backend server to send one. It will only return None
if the server has disconnected.
sourcepub fn timeout_iter(&mut self, timeout: Duration) -> TimeoutIter<'_>
pub fn timeout_iter(&mut self, timeout: Duration) -> TimeoutIter<'_>
Returns an iterator over notifications which blocks a limited amount of time.
If there are no already buffered pending notifications, this iterator will block waiting on the PostgreSQL
backend server to send one up to the provided timeout. A return value of None
either indicates that there are
no pending notifications or that the server has disconnected.
§Note
This iterator may start returning Some
after previously returning None
if more notifications are received.