pub struct Msg { /* private fields */ }
Expand description
Represents a pubsub message.
Implementations
sourceimpl Msg
impl Msg
This holds the data that comes from listening to a pubsub connection. It only contains actual message data.
sourcepub fn get_channel<T: FromRedisValue>(&self) -> RedisResult<T>
pub fn get_channel<T: FromRedisValue>(&self) -> RedisResult<T>
Returns the channel this message came on.
sourcepub fn get_channel_name(&self) -> &str
pub fn get_channel_name(&self) -> &str
Convenience method to get a string version of the channel. Unless
your channel contains non utf-8 bytes you can always use this
method. If the channel is not a valid string (which really should
not happen) then the return value is "?"
.
sourcepub fn get_payload<T: FromRedisValue>(&self) -> RedisResult<T>
pub fn get_payload<T: FromRedisValue>(&self) -> RedisResult<T>
Returns the message’s payload in a specific format.
sourcepub fn get_payload_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
pub fn get_payload_bytes(&self) -> &[u8]ⓘNotable traits for &[u8]impl<'_> Read for &[u8]impl<'_> Write for &mut [u8]
Returns the bytes that are the message’s payload. This can be used
as an alternative to the get_payload
function if you are interested
in the raw bytes in it.
sourcepub fn from_pattern(&self) -> bool
pub fn from_pattern(&self) -> bool
Returns true if the message was constructed from a pattern subscription.
sourcepub fn get_pattern<T: FromRedisValue>(&self) -> RedisResult<T>
pub fn get_pattern<T: FromRedisValue>(&self) -> RedisResult<T>
If the message was constructed from a message pattern this can be
used to find out which one. It’s recommended to match against
an Option<String>
so that you do not need to use from_pattern
to figure out if a pattern was set.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Msg
impl Send for Msg
impl Sync for Msg
impl Unpin for Msg
impl UnwindSafe for Msg
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more