Skip to main content

Crate surfer_translation_types

Crate surfer_translation_types 

Source

Re-exportsยง

pub use crate::translator::BasicTranslator;
pub use crate::translator::Translator;
pub use crate::translator::VariableNameInfo;
pub use crate::translator::WaveSource;
pub use crate::translator::translates_all_bit_types;
pub use crate::variable_index::VariableIndex;

Modulesยง

field_ref ๐Ÿ”’
plugin_types
result ๐Ÿ”’
scope_ref ๐Ÿ”’
translator
Definition of the main Translator trait and the simplified version BasicTranslator.
variable_index
variable_meta ๐Ÿ”’
variable_ref ๐Ÿ”’

Structsยง

FieldRef
A reference to a field of a larger variable, such as a field in a struct. The fields are the recursive path to the fields inside the (translated) root
HierFormatResult
PluginConfig
ScopeRef
SubFieldFlatTranslationResult
SubFieldTranslationResult
TranslatedValue
TranslationResult
VariableMeta
Additional information about a variable in the waveform.
VariableRef

Enumsยง

TranslationPreference
ValueKind
The kind of a translated value, used to determine how to color it in the UI.
ValueRepr
The representation of the value, compound values can be be represented by the repr of their subfields
VariableDirection
VariableEncoding
Variable values can be encoded in different ways in the waveform source.
VariableInfo
Static information about the structure of a variable.
VariableType
The type of variable based on information from the waveform source.
VariableValue
The value of a variable in the waveform as obtained from the waveform source.

Constantsยง

NAN_HIGHIMP
Quiet NaN representing high-impedance (Z) values in analog signals.
NAN_UNDEF
Quiet NaN representing undefined (X) values in analog signals.

Functionsยง

biguint_to_f64
Convert BigUint to f64 efficiently.
check_vector_variable
Turn vector variable string into name and corresponding color if it includes values other than 0 and 1. If only 0 and 1, return None. Related to kind_for_binary_representation, which returns only the kind.
extend_string
VCD bit extension. This function extends the given string val to match num_bits by adding leading characters according to VCD rules:
is_nan_highimp
Check NaN payload to determine if it represents HighImp.
kind_for_binary_representation
Return kind for a binary representation. Related to check_vector_variable, which returns the same kinds, but also a string. For strings containing only 0 and 1, this function returns ValueKind::Normal.
parse_numeric_string
Parse a translated string value into a numeric f64.
parse_value_to_numeric
Parse VariableValue to f64 using a conversion function.