Struct Event

• Defined in File messages.hpp

Struct Documentation

struct Event

A discrete event that occurred over a time range.

Public Functions

FoxgloveError encode(uint8_t *ptr, size_t len, size_t *encoded_len)

Encoded the Event as protobuf to the provided buffer.

On success, writes the serialized length to *encoded_len. If the provided buffer has insufficient capacity, writes the required capacity to *encoded_len and returns FoxgloveError::BufferTooShort. If the message cannot be encoded, writes the reason to stderr and returns FoxgloveError::EncodeError.

Parameters:

• ptr – the destination buffer. must point to at least len valid bytes.

• len – the length of the destination buffer.

• encoded_len – where the serialized length or required capacity will be written to.

Public Members

std::optional<Timestamp> start_time

Event start time (inclusive)

std::optional<Timestamp> end_time

Event end time (inclusive)

std::vector<KeyValuePair> metadata

Additional key-value metadata. Keys must be unique.

Public Static Functions

static Schema schema()

Get the Event schema.

The schema data returned is statically allocated.