pub struct Publish { /* private fields */ }
Expand description
Publish message
Implementations§
Source§impl Publish
impl Publish
pub fn retain(&self) -> bool
Sourcepub fn publish_topic(&self) -> &str
pub fn publish_topic(&self) -> &str
the information channel to which payload data is published.
Sourcepub fn id(&self) -> Option<NonZeroU16>
pub fn id(&self) -> Option<NonZeroU16>
only present in PUBLISH Packets where the QoS level is 1 or 2.
pub fn topic(&self) -> &Path<ByteString>
pub fn topic_mut(&mut self) -> &mut Path<ByteString>
pub fn packet(&self) -> &Publish
pub fn packet_mut(&mut self) -> &mut Publish
Sourcepub fn packet_size(&self) -> u32
pub fn packet_size(&self) -> u32
Returns size of the publish
Sourcepub fn payload_size(&self) -> usize
pub fn payload_size(&self) -> usize
Returns size of the payload
Sourcepub async fn read(&self) -> Result<Option<Bytes>, PayloadError>
pub async fn read(&self) -> Result<Option<Bytes>, PayloadError>
Payload that is being published.
Sourcepub async fn read_all(&self) -> Result<Option<Bytes>, PayloadError>
pub async fn read_all(&self) -> Result<Option<Bytes>, PayloadError>
Payload that is being published.
Sourcepub fn take_payload(&mut self) -> Payload
pub fn take_payload(&mut self) -> Payload
Replace packet’a payload with empty bytes, returns existing payload.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for Publish
impl !RefUnwindSafe for Publish
impl !Send for Publish
impl !Sync for Publish
impl Unpin for Publish
impl !UnwindSafe for Publish
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more