redis

Struct Msg

Source
pub struct Msg { /* private fields */ }
Expand description

Represents a pubsub message.

Implementations§

Source§

impl Msg

This holds the data that comes from listening to a pubsub connection. It only contains actual message data.

Source

pub fn from_value(value: &Value) -> Option<Self>

Tries to convert provided Value into Msg.

Source

pub fn from_owned_value(value: Value) -> Option<Self>

Tries to convert provided Value into Msg.

Source

pub fn from_push_info(push_info: PushInfo) -> Option<Self>

Tries to convert provided PushInfo into Msg.

Source

pub fn get_channel<T: FromRedisValue>(&self) -> RedisResult<T>

Returns the channel this message came on.

Source

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 "?".

Source

pub fn get_payload<T: FromRedisValue>(&self) -> RedisResult<T>

Returns the message’s payload in a specific format.

Source

pub fn get_payload_bytes(&self) -> &[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.

Source

pub fn from_pattern(&self) -> bool

Returns true if the message was constructed from a pattern subscription.

Source

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§

Source§

impl Clone for Msg

Source§

fn clone(&self) -> Msg

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Msg

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Msg

§

impl RefUnwindSafe for Msg

§

impl Send for Msg

§

impl Sync for Msg

§

impl Unpin for Msg

§

impl UnwindSafe for Msg

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T