Struct Payload 

pub struct Payload(/* private fields */);

A point’s payload (JSON data).

The payload stores arbitrary JSON data associated with a point.

Implementations

impl Payload

pub fn new() -> Self

Create a new empty payload.

pub fn from_value(value: JsonValue) -> Self

Create a payload from a JSON value.

pub fn value(&self) -> &JsonValue

Get the underlying JSON value.

pub fn value_mut(&mut self) -> &mut JsonValue

Get a mutable reference to the underlying JSON value.

pub fn into_value(self) -> JsonValue

Consume and return the underlying JSON value.

pub fn is_empty(&self) -> bool

Check if the payload is empty (null or empty object).

pub fn get(&self, key: &str) -> Option<&JsonValue>

Get a field from the payload.

pub fn insert(&mut self, key: impl Into<String>, value: JsonValue)

Insert a field into the payload.

The payload must be an object for this to work.

pub fn to_bytes(&self) -> Result<Vec<u8>, VectorError>

Encode the payload to bytes.

Errors

Returns an error if encoding fails.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, VectorError>

Decode a payload from bytes.

Errors

Returns an error if decoding fails.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Value> for Payload

fn from(value: JsonValue) -> Self

Converts to this type from the input type.

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Payload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Payload