Struct LineProtocol 

pub struct LineProtocol {
    pub measurement: Measurement,
    pub tags: Option<HashMap<TagKey, TagValue>>,
    pub fields: HashMap<FieldKey, FieldValue>,
    pub timestamp: Option<i64>,
}

Fields

measurement: Measurement

The data point measurement name

tags: Option<HashMap<TagKey, TagValue>>

The data point tag set

fields: HashMap<FieldKey, FieldValue>

The data point field set

timestamp: Option<i64>

To ensure a data point includes the time a metric is observed (not received by InfluxDB), include a timestamp if not defined

By default the timestamp is defined in nanoseconds. If you are using any other form of precision it needs to be defined when making the insert request

Implementations

impl LineProtocol

pub fn new<T>(measurement: T) -> Self

where T: Into<Measurement>,

Create a new LineProtocol for building a single data point

Args

• measurement - A valid measurement name

pub fn measurement<T>(self, measurement: T) -> Self

where T: Into<Measurement>,

Overwrite the measurement name with a new name

Example

let mut line_protocol = LineProtocol::new("measurement").add_field("key", "value");

line_protocol = line_protocol.measurement("new_measurement");

Args

• measurement - A valid measurement name

pub fn measurement_ref<T>(&mut self, measurement: T)

where T: Into<Measurement>,

Overwrite the measurement name with a new name

Example

let mut line_protocol = LineProtocol::new("measurement").add_field("key", "value");

line_protocol.measurement_ref("new_measurement");

Args

• measurement - A valid measurement name

pub fn add_tag<K, V>(self, key: K, value: V) -> Self

where K: Into<TagKey>, V: Into<TagValue>,

Add or update a tag key-value pair to the data point

This function is useful if you want to follow a builder pattern

Example

let line_protocol = LineProtocol::new("measurement").add_tag("key", "value");

Args

• key - A valid tag key
• value - A valid tag value

pub fn add_tag_ref<K, V>(&mut self, key: K, value: V)

where K: Into<TagKey>, V: Into<TagValue>,

Add or update a tag key-value pair to the data point

This function is useful if you want to build a data point dynamically

Example

let line_protocol = LineProtocol::new("measurement");

for (key, value) in tags {
    line_protocol.add_tag_ref(key, value);
}

Args

• key - A valid tag key
• value - A valid tag value

pub fn delete_tag<K>(self, key: K) -> Self

where K: Into<TagKey>,

Delete a tag from the data point

Args

• key - An existing TagKey

pub fn delete_tag_ref<K>(&mut self, key: K)

where K: Into<TagKey>,

Delete a tag from the data point

Args

• key - An existing TagKey

pub fn add_field<K, V>(self, key: K, value: V) -> Self

where K: Into<FieldKey>, V: Into<FieldValue>,

Add or update a field key-value pair to the data point

This function is useful if you want to follow a builder pattern

Example

let line_protocol = LineProtocol::new("measurement").add_field("key", "value");

Args

• key - A valid field key
• value - A valid field value

pub fn add_field_ref<K, V>(&mut self, key: K, value: V)

where K: Into<FieldKey>, V: Into<FieldValue>,

Add or update a field key-value pair to the data point

This function is useful if you want to build a data point dynamically

Example

let line_protocol = LineProtocol::new("measurement");

for (key, value) in fields {
    line_protocol.add_field_ref(key, value);
}

Args

• key - A valid field key
• value - A valid field value

pub fn delete_field<K>(self, key: K) -> Self

where K: Into<FieldKey>,

Delete a field from the data point

Args

• key - An existing FieldKey

pub fn delete_field_ref<K>(&mut self, key: K)

where K: Into<FieldKey>,

Delete a field from the data point

Args

• key - An existing FieldKey

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

where T: Into<i64>,

Set the timestamp for the data point

It is recommend to set a timestamp. By default InfluxDB v2 expects the timestamp to be in nanosecond precision. If you are using any other form of precision it needs to be explicitly set when making the query

Example

let line_protocol = LineProtocol::new("measurement");
    .with_timestamp(1729270461612452700i64);

Args

• timestamp - A unix timestamp

pub fn with_timestamp_ref<T>(&mut self, timestamp: T)

where T: Into<i64>,

Set the timestamp for the data point

It is recommend to set a timestamp. By default InfluxDB v2 expects the timestamp to be in nanosecond precision. If you are using any other form of precision it needs to be explicitly set when making the query

Example

let line_protocol = LineProtocol::new("measurement");
line_protocol.with_timestamp_ref(1729270461612452700i64);

Args

• timestamp - A unix timestamp

pub fn delete_timestamp(self) -> Self

Delete the set timestamp

Example

let mut line_protocol = LineProtocol::new("measurement")
    .add_field("key", "value")
    .with_timestamp_ref(1729270461612452700i64);

line_protocol = line_protocol.delete_timestamp();

pub fn delete_timestamp_ref(&mut self)

Delete the set timestamp

Example

let mut line_protocol = LineProtocol::new("measurement")
    .add_field("key", "value")
    .with_timestamp_ref(1729270461612452700i64);

line_protocol.delete_timestamp();

pub fn build(&self) -> Result<String, LineProtocolError>

Builds an InfluxDB v2 data point using the previously defined measurement name, optional tags, fields, and an optional timestamp

In addition validation checks are performed on the individual parts

impl LineProtocol

pub fn parse_line(line: &str) -> Result<Self, LineProtocolError>

Parse a single line protocol line into the LineProtocol struct

Allows for modifying the line protocol by adding or removing fields/tags and rebuilding

Example

let line = "measurement,tag=value field=true 1729270461612452700"
let parsed_line = LineProtocol::parse_line(line).unwrap();

parsed_line.delete_tag("tag");
parsed_line.add_field("field2", "hello");
parsed_line.with_timestamp(1729270461612452800i64)

let line = parsed_line.build().unwrap();
// Output: measurement field=true,field2="hello" 1729270461612452800

Args

• line - A InfluxDB line protocol line

pub fn parse_vec(lines: Vec<&str>) -> Result<Vec<Self>, LineProtocolError>

Parse a vector of lines

Empty lines and comment lines are silently ignored

Example

let lines = vec![
    "measurement,tag=value field=\"value\"",
    "measurement,tag=value field=true 1729270461612452700",
    ...
];

let parsed = LineProtocol::parse_vec(lines).unwrap();

Args

• lines - An array of InfluxDB line protocol lines

pub fn parse_lines(lines: &str) -> Result<Vec<Self>, LineProtocolError>

Parse multiple lines seprated by a newline (\n)

Empty lines and comment lines are silently ignored

Example

let lines = vec![
    "measurement,tag=value field=\"value\"",
    "measurement,tag=value field=true 1729270461612452700",
    ...
];

let parsed = LineProtocol::parse_lines(lines.join("\n")).unwrap();

Args

• lines - Multiple InfluxDB line protocol lines seperated by a newline

impl LineProtocol

pub fn get_measurement(&self) -> Measurement

Get a cloned version of the measurement

pub fn get_measurement_ref(&self) -> &Measurement

Get a reference of the measurement

pub fn get_measurement_mut(&mut self) -> &mut Measurement

Get a mutable reference of the measurement

pub fn get_tag<K>(&self, key: K) -> Option<TagValue>

where K: Into<TagKey>,

Get the tag value associated with the provided tag key

Args

• key - A valid tag key

pub fn get_tag_ref<K>(&self, key: K) -> Option<&TagValue>

where K: Into<TagKey>,

Get a reference to the tag value associated with the provided tag key

Args

• key - A valid tag key

pub fn get_tag_mut<K>(&mut self, key: K) -> Option<&mut TagValue>

where K: Into<TagKey>,

Get a mutable reference to the tag value associated with the provided tag key

Args

• key - A valid tag key

pub fn get_field<K>(&self, key: K) -> Option<FieldValue>

where K: Into<FieldKey>,

Get the field value associated with the provided field key

Args

• key - A valid field key

pub fn get_field_ref<K>(&self, key: K) -> Option<&FieldValue>

where K: Into<FieldKey>,

Get a reference to the field value associated with the provided field key

Args

• key - A valid field key

pub fn get_field_mut<K>(&mut self, key: K) -> Option<&mut FieldValue>

where K: Into<FieldKey>,

Get a mutable reference to the field value associated with the provided field key

Args

• key - A valid field key

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

Get a cloned version of the timestamp

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

Get a reference of the timestamp

pub fn get_timestamp_mut(&mut self) -> Option<&mut i64>

Get a mutable reference of the timestamp

Trait Implementations

impl Clone for LineProtocol

fn clone(&self) -> LineProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineProtocol

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

Formats the value using the given formatter.

impl Display for LineProtocol

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

Formats the value using the given formatter.

impl PartialEq for LineProtocol

fn eq(&self, other: &Self) -> 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.