Struct zenoh::sample::Sample

#[non_exhaustive]
pub struct Sample {
    pub key_expr: KeyExpr<'static>,
    pub value: Value,
    pub kind: SampleKind,
    pub timestamp: Option<Timestamp>,
    pub qos: QoS,
    pub source_info: SourceInfo,
    pub attachment: Option<Attachment>,
}

A zenoh sample.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_expr: KeyExpr<'static>

The key expression on which this Sample was published.

value: Value

The value of this Sample.

kind: SampleKind

The kind of this Sample.

timestamp: Option<Timestamp>

The Timestamp of this Sample.

qos: QoS

Quality of service settings this sample was sent with.

source_info: SourceInfo

Available on crate feature unstable only.

🔬 This API has been marked as unstable: it works as advertised, but we may change it in a future release. To use it, you must enable zenoh's unstable feature flag.

Infos on the source of this Sample.

attachment: Option<Attachment>

Available on crate feature unstable only.

🔬 This API has been marked as unstable: it works as advertised, but we may change it in a future release. To use it, you must enable zenoh's unstable feature flag.

A map of key-value pairs, where each key and value are byte-slices.

Implementations

impl Sample

pub fn new<IntoKeyExpr, IntoValue>( key_expr: IntoKeyExpr, value: IntoValue ) -> Self

where IntoKeyExpr: Into<KeyExpr<'static>>, IntoValue: Into<Value>,

Creates a new Sample.

pub fn try_from<TryIntoKeyExpr, IntoValue>( key_expr: TryIntoKeyExpr, value: IntoValue ) -> Result<Self, Error>

where TryIntoKeyExpr: TryInto<KeyExpr<'static>>, <TryIntoKeyExpr as TryInto<KeyExpr<'static>>>::Error: Into<Error>, IntoValue: Into<Value>,

Creates a new Sample.

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

Gets the timestamp of this Sample.

pub fn with_timestamp(self, timestamp: Timestamp) -> Self

Sets the timestamp of this Sample.

pub fn with_source_info(self, source_info: SourceInfo) -> Self

Available on crate feature unstable only.

Sets the source info 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 ensure_timestamp(&mut self) -> &Timestamp

Ensure that an associated Timestamp is present in this Sample. If not, a new one is created with the current system time and 0x00 as id. Get the timestamp of this sample (either existing one or newly created)

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

Available on crate feature unstable only.

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

Available on crate feature unstable only.

pub fn with_attachment(self, attachment: Attachment) -> Self

Available on crate feature unstable only.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy 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 DerefMut for Sample

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Sample

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

Formats the value using the given formatter.

impl From<Sample> for Value

fn from(s: Sample) -> Self

Converts to this type from the input type.

impl TryFrom<Reply> for Sample

type Error = Value

The type returned in the event of a conversion error.

fn try_from(value: Reply) -> Result<Self, Self::Error>

Performs the conversion.

impl Deref for Sample

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.