Struct GCBorrowedDatapointValue 

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

A wrapper around a GCDatapointValue that takes ownership of a datapoint value across the C ABI boundary and ensures the memory is deallocated when the object is dropped This wraps the raw C struct returned by the raw::gc_plugin_receive_datapoint function and ensures that the appropriate deallocation function is called when the object is dropped.

It defers from GCDatapointValue in that it ensures that the memory is deallocated when the object is dropped.

NOTE: This object must not be created directly by plugins, it should only be created by the gateway core! For this purpose, the GCDatapointValue object should be used.

Implementations

impl GCBorrowedDatapointValue

pub fn copy(&self) -> GCDatapointValue

Copies the borrowed datapoint value into a new owned datapoint value

Methods from Deref<Target = GCDatapointValue>

pub fn get_value(&self) -> Result<GCDatapointValueType, GCPluginABIError>

Get the value of the current datapoint This method may add a slight overhead to the execution time, if the value is already known it is recommended to use the specific getter methods It returns an error if the value is not supported or unknown

pub fn get_value_bool(&self) -> Option<bool>

Get the value of the current datapoint as a boolean Returns None if the value is not a boolean

pub fn get_value_double_point(&self) -> Option<u8>

Get the value of the current datapoint as a double point Returns None if the value is not a double point

pub fn get_value_i64(&self) -> Option<i64>

Get the value of the current datapoint as a 64 bit signed integer Returns None if the value is not a 64 bit signed integer

pub fn get_value_i32(&self) -> Option<i32>

Get the value of the current datapoint as a 32 bit signed integer Returns None if the value is not a 32 bit signed integer

pub fn get_value_u32(&self) -> Option<u32>

Get the value of the current datapoint as a 32 bit unsigned integer Returns None if the value is not a 32 bit unsigned integer

pub fn get_value_u64(&self) -> Option<u64>

Get the value of the current datapoint as a 64 bit unsigned integer Returns None if the value is not a 64 bit unsigned integer

pub fn get_value_f64(&self) -> Option<f64>

Get the value of the current datapoint as a 64 bit floating point Returns None if the value is not a 64 bit floating point

pub fn get_value_f32(&self) -> Option<f32>

Get the value of the current datapoint as a 32 bit floating point Returns None if the value is not a 32 bit floating point

pub fn get_value_timestamp_ns(&self) -> Option<u64>

Get the value of the current datapoint as a timestamp in nanoseconds Returns None if the value is not a timestamp

pub fn get_value_bytes(&self) -> Option<Vec<u8>>

Get the value of the current datapoint as a byte array Returns None if the value is not a byte array

pub fn get_timestamp(&self) -> u64

Returns the timestamp of the datapoint value

pub fn get_id(&self) -> u64

Returns the datapoint id of the datapoint value

pub fn get_quality(&self) -> GCDatapointValueQuality

Returns the quality of the datapoint value

pub fn as_raw(&self) -> sGCDatapointValue

Returns the raw representation of the datapoint value

Trait Implementations

impl Debug for GCBorrowedDatapointValue

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

Formats the value using the given formatter.

impl Deref for GCBorrowedDatapointValue

type Target = GCDatapointValue

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for GCBorrowedDatapointValue

fn drop(&mut self)

Executes the destructor for this type.

impl From<*mut sGCDatapointValue> for GCBorrowedDatapointValue

fn from(datapoint_value: GCDatapointValue) -> Self

Converts to this type from the input type.

impl Send for GCBorrowedDatapointValue

impl Sync for GCBorrowedDatapointValue