Enum zenoh::Value

pub enum Value {
    Raw(ZInt, RBuf),
    Custom {
        encoding_descr: String,
        data: RBuf,
    },
    StringUtf8(String),
    Properties(Properties),
    Json(String),
    Integer(i64),
    Float(f64),
}

A user value that is associated with a Path in zenoh.

Variants

Raw(ZInt, RBuf)

A value as a bytes buffer (RBuf) and an encoding flag.
See zenoh::net::enocding for available flags.

Custom

A value as a bytes buffer and an encoding description (free String).
Note: this is equivalent to Raw(APP_CUSTOM, buf) where buf contains the encoding description and the data.

Fields of Custom

encoding_descr: Stringdata: RBuf

StringUtf8(String)

A String value.
Note: this is equivalent to Raw(STRING, buf) where buf contains the String

Properties(Properties)

A Properties value.
Note: this is equivalent to Raw(APP_PROPERTIES, buf) where buf contains the Properties encoded as a String

Json(String)

A Json value (string format).
Note: this is equivalent to Raw(APP_JSON, buf) where buf contains the Json string

Integer(i64)

An Integer value.
Note: this is equivalent to Raw(APP_INTEGER, buf) where buf contains the integer encoded as a String

Float(f64)

An Float value.
Note: this is equivalent to Raw(APP_FLOAT, buf) where buf contains the float encoded as a String

Implementations

impl Value

pub fn encoding(&self) -> ZInt

Returns the encoding flag of the Value.

pub fn encoding_descr(&self) -> String

Returns the encoding description of the Value.

pub fn encode(self) -> (ZInt, RBuf)

Encodes the Value and return the resulting buffer and its encoding flag.

pub fn decode(encoding: ZInt, payload: RBuf) -> ZResult<Value>

Decodes the payload according to the encoding flag.

pub fn encode_to_string(self) -> (ZInt, bool, String)

Encodes the Value as an UTF-8 String, possibly converting it to base64 its content is not UTF-8 compatible. Returns a tuple containing the encoding flag, a boolean indicating if the content has been encoded to base64 and the resulting UTF-8 String.

Note: for Custom Value, the resulting String will have the format: encoding_descr + ':' + data_as_a_string (Therefore, the encoding_descr must not contain the ‘:’ character)

pub fn decode_from_string(
    encoding: ZInt,
    base64: bool,
    s: String
) -> ZResult<Value>

Decodes the payload from a string according to the encoding flag, converting the string from base64 if the boolean is true (for UTF-8 compatible Values).

pub fn from_sample(
    sample: &Sample,
    decode_value: bool
) -> ZResult<Option<Value>>

Convert the payload from a Sample into a Value. If the Sample’s kind is DELETE, Ok(None) is returned. Otherwise, if decode_value is true the payload is decoded as a typed Value. If decode_value is false, the payload is converted into a Value::Raw.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl From<&'_ [u8]> for Value

fn from(buf: &[u8]) -> Self

Performs the conversion.

impl From<&'_ Value> for Value

fn from(json: &Value) -> Self

Performs the conversion.

impl From<&'_ str> for Value

fn from(s: &str) -> Self

Performs the conversion.

impl From<Properties> for Value

fn from(p: Properties) -> Self

Performs the conversion.

impl From<RBuf> for Value

fn from(buf: RBuf) -> Self

Performs the conversion.

impl From<String> for Value

fn from(s: String) -> Self

Performs the conversion.

impl From<Value> for Value

fn from(json: Value) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Value

fn from(buf: Vec<u8>) -> Self

Performs the conversion.

impl From<f64> for Value

fn from(f: f64) -> Self

Performs the conversion.

impl From<i64> for Value

fn from(i: i64) -> Self

Performs the conversion.