pub struct VariableSchema {
pub variables: HashMap<String, VariableInfo>,
pub frame_size: usize,
}Expand description
Schema describing the structure and metadata of telemetry variables.
Fields§
§variables: HashMap<String, VariableInfo>Map of variable names to their metadata (provides O(1) lookup)
frame_size: usizeTotal size of a telemetry frame in bytes
Implementations§
Source§impl VariableSchema
impl VariableSchema
Sourcepub fn new(
variables: HashMap<String, VariableInfo>,
frame_size: usize,
) -> Result<VariableSchema, TelemetryError>
pub fn new( variables: HashMap<String, VariableInfo>, frame_size: usize, ) -> Result<VariableSchema, TelemetryError>
Create a new VariableSchema with validation.
Sourcepub fn validate(&self) -> Result<(), TelemetryError>
pub fn validate(&self) -> Result<(), TelemetryError>
Validate the schema for consistency.
Sourcepub fn get_variable(&self, name: &str) -> Option<&VariableInfo>
pub fn get_variable(&self, name: &str) -> Option<&VariableInfo>
Get variable info by name (O(1) lookup).
Sourcepub fn has_variable(&self, name: &str) -> bool
pub fn has_variable(&self, name: &str) -> bool
Check if a variable exists.
Sourcepub fn variable_count(&self) -> usize
pub fn variable_count(&self) -> usize
Get the number of variables.
Trait Implementations§
Source§impl Clone for VariableSchema
impl Clone for VariableSchema
Source§fn clone(&self) -> VariableSchema
fn clone(&self) -> VariableSchema
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for VariableSchema
impl Debug for VariableSchema
Source§impl<'de> Deserialize<'de> for VariableSchema
impl<'de> Deserialize<'de> for VariableSchema
Source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<VariableSchema, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<VariableSchema, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl Flatten for VariableSchema
Source§impl NamedType for VariableSchema
impl NamedType for VariableSchema
fn sid() -> SpectaID
Source§fn named_data_type(
type_map: &mut TypeCollection,
generics: &[DataType],
) -> NamedDataType
fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType
this is equivalent to Type::inline but returns a NamedDataType instead.
Source§fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType
fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType
this is equivalent to [Type::definition] but returns a NamedDataType instead.
Source§impl Serialize for VariableSchema
impl Serialize for VariableSchema
Source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
Source§impl Type for VariableSchema
impl Type for VariableSchema
Source§fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType
fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType
Returns the definition of a type using the provided generics. Read more
Source§fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference
fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference
Generates a datatype corresponding to a reference to this type,
as determined by its category. Getting a reference to a type implies that
it should belong in the type map (since it has to be referenced from somewhere),
so the output of
definition will be put into the type map.Auto Trait Implementations§
impl Freeze for VariableSchema
impl RefUnwindSafe for VariableSchema
impl Send for VariableSchema
impl Sync for VariableSchema
impl Unpin for VariableSchema
impl UnsafeUnpin for VariableSchema
impl UnwindSafe for VariableSchema
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more