Struct Sample 

#[non_exhaustive]
pub struct Sample { /* private fields */ }

The Sample structure is the data unit received by Subscriber or Querier or Session::get. It contains the payload and all metadata associated with the data.

Implementations

impl Sample

pub fn key_expr(&self) -> &KeyExpr<'static>

Gets the key expression on which this Sample was published.

pub fn payload(&self) -> &ZBytes

Gets the payload of this Sample.

pub fn payload_mut(&mut self) -> &mut ZBytes

Gets the payload of this Sample.

pub fn kind(&self) -> SampleKind

Gets the kind of this Sample.

pub fn encoding(&self) -> &Encoding

Gets the encoding of this sample.

pub fn timestamp(&self) -> Option<&Timestamp>

Gets the timestamp of this Sample.

pub fn congestion_control(&self) -> CongestionControl

Gets the congestion control of this Sample.

pub fn priority(&self) -> Priority

Gets the priority of this Sample.

pub fn reliability(&self) -> Reliability

Available on crate feature unstable only.

Gets the reliability of this Sample.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn express(&self) -> bool

Gets the express flag value. If true, the message is not batched during transmission, in order to reduce latency.

pub fn source_info(&self) -> Option<&SourceInfo>

Available on crate feature unstable only.

Gets info on the source of this Sample.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn attachment(&self) -> Option<&ZBytes>

Gets the sample attachment: a map of key-value pairs, where each key and each value is a byte-slice.

pub fn attachment_mut(&mut self) -> Option<&mut ZBytes>

Gets the sample attachment: a map of key-value pairs, where each key and each value is a byte-slice.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl From<Sample> for SampleBuilder<SampleBuilderAny>

fn from(sample: Sample) -> Self

Converts to this type from the input type.

impl From<Sample> for SampleFields

fn from(sample: Sample) -> Self

Converts to this type from the input type.

impl<T> From<SampleBuilder<T>> for Sample

fn from(sample_builder: SampleBuilder<T>) -> Self

Converts to this type from the input type.

impl Sink<Sample> for Publisher<'_>

type Error = Box<dyn Error + Sync + Send>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Sample) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl TryFrom<Sample> for SampleBuilder<SampleBuilderDelete>

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(sample: Sample) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Sample> for SampleBuilder<SampleBuilderPut>

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(sample: Sample) -> Result<Self, Self::Error>

Performs the conversion.