Skip to main content

NotifyChannel

Struct NotifyChannel 

Source
pub struct NotifyChannel<T> { /* private fields */ }
Expand description

Typed handle to a single PostgreSQL NOTIFY channel.

T is the JSON payload shape. Construct one per channel as a const-ish value (name is &'static str) and reuse it everywhere that channel is touched, so publish and subscribe sites can never disagree on the shape.

Implementations§

Source§

impl<T> NotifyChannel<T>

Source

pub const fn new(name: &'static str) -> Self

Create a typed channel handle. name is the PostgreSQL channel identifier passed to pg_notify and LISTEN; it must be a valid SQL identifier (the framework uses snake_case forge_* names).

Source

pub const fn name(&self) -> &'static str

PostgreSQL channel name.

Source§

impl<T> NotifyChannel<T>
where T: Serialize,

Source

pub async fn publish<'e, E>(&self, executor: E, payload: &T) -> Result<()>
where E: PgExecutor<'e>,

Publish payload on this channel.

Errors:

  • ForgeError::Serialization if serde_json::to_string(payload) fails.
  • ForgeError::InvalidArgument if the serialized payload exceeds MAX_PAYLOAD_BYTES. Use the change-log fallback for larger bodies.
  • ForgeError::Database if the underlying SELECT pg_notify(...) fails (transaction rolled back, connection dropped, etc.).
Source§

impl<T> NotifyChannel<T>
where T: DeserializeOwned + Send + 'static,

Source

pub async fn subscribe( &self, listener: PgListener, ) -> Result<impl Stream<Item = T>>

Subscribe to this channel and return a stream of decoded payloads.

listener is consumed; the caller surrenders the connection to the stream for the duration of the subscription. Notifications whose payload fails JSON decoding are logged and skipped, so a malformed publish from one peer cannot tear down a long-running subscriber. Errors from the underlying recv (connection dropped, etc.) end the stream; the caller decides whether to reconnect.

Auto Trait Implementations§

§

impl<T> Freeze for NotifyChannel<T>

§

impl<T> RefUnwindSafe for NotifyChannel<T>

§

impl<T> Send for NotifyChannel<T>

§

impl<T> Sync for NotifyChannel<T>

§

impl<T> Unpin for NotifyChannel<T>

§

impl<T> UnsafeUnpin for NotifyChannel<T>

§

impl<T> UnwindSafe for NotifyChannel<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more