Struct sqlx::postgres::PgListener

pub struct PgListener { /* fields omitted */ }

This is supported on feature="postgres" only.

A stream of asynchronous notifications from Postgres.

This listener will auto-reconnect. If the active connection being used ever dies, this listener will detect that event, create a new connection, will re-subscribe to all of the originally specified channels, and will resume operations as normal.

Methods

impl PgListener

pub async fn new(url: &'_ str) -> Result<PgListener, Error>

This is supported on feature="postgres" only.

pub async fn from_pool(
    pool: &'_ Pool<PgConnection>
) -> Result<PgListener, Error>

This is supported on feature="postgres" only.

pub async fn listen(&'_ mut self, channel: &'_ str) -> Result<(), Error>

This is supported on feature="postgres" only.

Starts listening for notifications on a channel.

pub async fn listen_all<'_>(
    &'_ mut self,
    channels: impl IntoIterator<Item = &'_ str>
) -> Result<(), Error>

This is supported on feature="postgres" only.

Starts listening for notifications on all channels.

pub async fn unlisten(&'_ mut self, channel: &'_ str) -> Result<(), Error>

This is supported on feature="postgres" only.

Stops listening for notifications on a channel.

pub async fn unlisten_all(&'_ mut self) -> Result<(), Error>

This is supported on feature="postgres" only.

Stops listening for notifications on all channels.

pub async fn recv(&'_ mut self) -> Result<PgNotification<'_>, Error>

This is supported on feature="postgres" only.

Receives the next notification available from any of the subscribed channels.

pub fn into_stream(
    self
) -> impl Unpin + Stream<Item = Result<PgNotification<'static>, Error>>

This is supported on feature="postgres" only.

Consume this listener, returning a Stream of notifications.

Trait Implementations

impl Executor for PgListener

type Database = Postgres

The specific database that this type is implemented for.

fn execute<'e, 'q, 'c, E>(
    &'c mut self,
    query: E
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + 'e + Send>> where
    'q: 'e,
    'c: 'e,
    E: 'e + Execute<'q, <PgListener as Executor>::Database>, 

Executes the query for its side-effects and discarding any potential result rows.

fn fetch<'q, E>(&mut self, query: E) -> PgCursor<'q> where
    E: Execute<'q, <PgListener as Executor>::Database>, 

Executes a query for its result.

impl<'c> RefExecutor<'c> for &'c mut PgListener

type Database = Postgres

fn fetch_by_ref<'q, E>(self, query: E) -> PgCursor<'c, 'q> where
    E: Execute<'q, <&'c mut PgListener as RefExecutor<'c>>::Database>,