Enum Message

pub enum Message {
    SetActiveScope(ScopeType),
    AddVariables(Vec<VariableRef>),
    AddScope(ScopeRef, bool),
    AddScopeAsGroup(ScopeRef, bool),
    AddCount(char),
    AddStreamOrGenerator(TransactionStreamRef),
    AddStreamOrGeneratorFromName(Option<StreamScopeRef>, String),
    AddAllFromStreamScope(String),
    InvalidateCount,
    RemoveItemByIndex(VisibleItemIndex),
    RemoveItems(Vec<DisplayedItemRef>),
    FocusItem(VisibleItemIndex),
    ItemSelectRange(VisibleItemIndex),
    ItemSelectAll,
    UnfocusItem,
    RenameItem(Option<VisibleItemIndex>),
    MoveFocus(MoveDir, usize, bool),
    MoveFocusedItem(MoveDir, usize),
    FocusTransaction(Option<TransactionRef>, Option<Transaction>),
    VerticalScroll(MoveDir, usize),
    ScrollToItem(usize),
    SetScrollOffset(f32),
    VariableFormatChange(MessageTarget<DisplayedFieldRef>, String),
    ItemSelectionClear,
    ItemColorChange(MessageTarget<VisibleItemIndex>, Option<String>),
    ItemBackgroundColorChange(MessageTarget<VisibleItemIndex>, Option<String>),
    ItemNameChange(Option<VisibleItemIndex>, Option<String>),
    ItemHeightScalingFactorChange(MessageTarget<VisibleItemIndex>, f32),
    ChangeVariableNameType(MessageTarget<VisibleItemIndex>, VariableNameType),
    ForceVariableNameTypes(VariableNameType),
    SetNameAlignRight(bool),
    SetClockHighlightType(ClockHighlightType),
    SetFillHighValues(bool),
    ResetVariableFormat(DisplayedFieldRef),
    CanvasScroll {
        delta: Vec2,
        viewport_idx: usize,
    },
    CanvasZoom {
        mouse_ptr: Option<BigInt>,
        delta: f32,
        viewport_idx: usize,
    },
    ZoomToRange {
        start: BigInt,
        end: BigInt,
        viewport_idx: usize,
    },
    CursorSet(BigInt),
    SurferServerStatus(Instant, String, Status),
    LoadFile(Utf8PathBuf, LoadOptions),
    LoadWaveformFileFromUrl(String, LoadOptions),
    LoadFromData(Vec<u8>, LoadOptions),
    LoadWasmTranslator(Utf8PathBuf),
    LoadSpadeTranslator {
        top: String,
        state: String,
    },
    LoadCommandFile(Utf8PathBuf),
    LoadCommandFromData(Vec<u8>),
    LoadCommandFileFromUrl(String),
    SetupCxxrtl(CxxrtlKind),
    WaveHeaderLoaded(Instant, WaveSource, LoadOptions, HeaderResult),
    WaveBodyLoaded(Instant, WaveSource, BodyResult),
    WavesLoaded(WaveSource, WaveFormat, Box<WaveContainer>, LoadOptions),
    SignalsLoaded(Instant, LoadSignalsResult),
    TransactionStreamsLoaded(WaveSource, WaveFormat, TransactionContainer, LoadOptions),
    Error(Error),
    TranslatorLoaded(Box<DynTranslator>),
    BlacklistTranslator(VariableRef, String),
    ShowCommandPrompt(Option<String>),
    FileDropped(DroppedFile),
    FileDownloaded(String, Bytes, LoadOptions),
    CommandFileDownloaded(String, Bytes),
    ReloadConfig,
    ReloadWaveform(bool),
    SuggestReloadWaveform,
    CloseReloadWaveformDialog {
        reload_file: bool,
        do_not_show_again: bool,
    },
    UpdateReloadWaveformDialog(ReloadWaveformDialog),
    OpenSiblingStateFile(bool),
    SuggestOpenSiblingStateFile,
    CloseOpenSiblingStateFileDialog {
        load_state: bool,
        do_not_show_again: bool,
    },
    UpdateOpenSiblingStateFileDialog(OpenSiblingStateFileDialog),
    RemovePlaceholders,
    ZoomToFit {
        viewport_idx: usize,
    },
    GoToStart {
        viewport_idx: usize,
    },
    GoToEnd {
        viewport_idx: usize,
    },
    GoToTime(Option<BigInt>, usize),
    ToggleMenu,
    ToggleToolbar,
    ToggleOverview,
    ToggleStatusbar,
    ToggleIndices,
    ToggleDirection,
    ToggleEmptyScopes,
    ToggleParametersInScopes,
    ToggleSidePanel,
    ToggleItemSelected(Option<VisibleItemIndex>),
    ToggleDefaultTimeline,
    ToggleTickLines,
    ToggleVariableTooltip,
    ToggleScopeTooltip,
    ToggleFullscreen,
    SetTimeUnit(TimeUnit),
    SetTimeStringFormatting(Option<TimeStringFormatting>),
    SetHighlightFocused(bool),
    CommandPromptClear,
    CommandPromptUpdate {
        suggestions: Vec<(String, Vec<bool>)>,
    },
    CommandPromptPushPrevious(String),
    SelectPrevCommand,
    SelectNextCommand,
    OpenFileDialog(OpenMode),
    OpenCommandFileDialog,
    SaveStateFile(Option<PathBuf>),
    LoadStateFile(Option<PathBuf>),
    LoadState(Box<UserState>, Option<PathBuf>),
    SetStateFile(PathBuf),
    SetAboutVisible(bool),
    SetKeyHelpVisible(bool),
    SetGestureHelpVisible(bool),
    SetQuickStartVisible(bool),
    SetUrlEntryVisible(bool, Option<Box<dyn Fn(String) -> Message + Send + 'static>>),
    SetLicenseVisible(bool),
    SetRenameItemVisible(bool),
    SetLogsVisible(bool),
    SetMouseGestureDragStart(Option<Pos2>),
    SetMeasureDragStart(Option<Pos2>),
    SetFilterFocused(bool),
    SetVariableNameFilterType(VariableNameFilterType),
    SetVariableNameFilterCaseInsensitive(bool),
    SetVariableIOFilter(VariableIOFilterType, bool),
    SetVariableGroupByDirection(bool),
    SetUIZoomFactor(f32),
    SetPerformanceVisible(bool),
    SetContinuousRedraw(bool),
    SetCursorWindowVisible(bool),
    SetHierarchyStyle(HierarchyStyle),
    SetArrowKeyBindings(ArrowKeyBindings),
    AddDivider(Option<String>, Option<VisibleItemIndex>),
    AddTimeLine(Option<VisibleItemIndex>),
    AddMarker {
        time: BigInt,
        name: Option<String>,
        move_focus: bool,
    },
    SetMarker {
        id: u8,
        time: BigInt,
    },
    RemoveMarker(u8),
    MoveMarkerToCursor(u8),
    GoToCursorIfNotInView,
    GoToMarkerPosition(u8, usize),
    MoveCursorToTransition {
        next: bool,
        variable: Option<VisibleItemIndex>,
        skip_zero: bool,
    },
    MoveTransaction {
        next: bool,
    },
    VariableValueToClipbord(MessageTarget<VisibleItemIndex>),
    VariableNameToClipboard(MessageTarget<VisibleItemIndex>),
    VariableFullNameToClipboard(MessageTarget<VisibleItemIndex>),
    InvalidateDrawCommands,
    AddGraphic(GraphicId, Graphic),
    RemoveGraphic(GraphicId),
    VariableDragStarted(VisibleItemIndex),
    VariableDragTargetChanged(TargetPosition),
    VariableDragFinished,
    AddDraggedVariables(Vec<VariableRef>),
    UnpauseSimulation,
    PauseSimulation,
    ExpandDrawnItem {
        item: DisplayedItemRef,
        levels: usize,
    },
    SetViewportStrategy(ViewportStrategy),
    SetConfigFromString(String),
    AddCharToPrompt(char),
    Batch(Vec<Message>),
    AddViewport,
    RemoveViewport,
    SelectTheme(Option<String>),
    Undo(usize),
    Redo(usize),
    DumpTree,
    GroupNew {
        name: Option<String>,
        before: Option<ItemIndex>,
        items: Option<Vec<DisplayedItemRef>>,
    },
    GroupDissolve(Option<DisplayedItemRef>),
    GroupFold(Option<DisplayedItemRef>),
    GroupUnfold(Option<DisplayedItemRef>),
    GroupFoldRecursive(Option<DisplayedItemRef>),
    GroupUnfoldRecursive(Option<DisplayedItemRef>),
    GroupFoldAll,
    GroupUnfoldAll,
    StartWcpServer {
        address: Option<String>,
        initiate: bool,
    },
    StopWcpServer,
    SetupChannelWCP,
    Exit,
    ExpandParameterSection,
    AsyncDone(AsyncJob),
}

The design of Surfer relies on sending messages to trigger actions.

Variants

SetActiveScope(ScopeType)

Set active scope

AddVariables(Vec<VariableRef>)

Add one or more variables to wave view.

AddScope(ScopeRef, bool)

Add scope to wave view. If second argument is true, add subscopes recursively.

AddScopeAsGroup(ScopeRef, bool)

Add scope to wave view as a group. If second argument is true, add subscopes recursively.

AddCount(char)

Add a character to the repeat command counter.

AddStreamOrGenerator(TransactionStreamRef)

AddStreamOrGeneratorFromName(Option<StreamScopeRef>, String)

AddAllFromStreamScope(String)

InvalidateCount

Reset the repeat command counter.

RemoveItemByIndex(VisibleItemIndex)

RemoveItems(Vec<DisplayedItemRef>)

FocusItem(VisibleItemIndex)

Focus a wave/item.

ItemSelectRange(VisibleItemIndex)

ItemSelectAll

Select all waves/items.

UnfocusItem

Unfocus a wave/item.

RenameItem(Option<VisibleItemIndex>)

MoveFocus(MoveDir, usize, bool)

MoveFocusedItem(MoveDir, usize)

FocusTransaction(Option<TransactionRef>, Option<Transaction>)

VerticalScroll(MoveDir, usize)

ScrollToItem(usize)

Scroll in vertical direction so that the item at a given location in the list is at the top (or visible).

SetScrollOffset(f32)

VariableFormatChange(MessageTarget<DisplayedFieldRef>, String)

Change format (translator) of a variable. Passing None as first element means all selected variables.

ItemSelectionClear

ItemColorChange(MessageTarget<VisibleItemIndex>, Option<String>)

Change color of waves/items. If first argument is None, change for selected items. If second argument is None, change to default value.

ItemBackgroundColorChange(MessageTarget<VisibleItemIndex>, Option<String>)

Change background color of waves/items. If first argument is None, change for selected items. If second argument is None, change to default value.

ItemNameChange(Option<VisibleItemIndex>, Option<String>)

ItemHeightScalingFactorChange(MessageTarget<VisibleItemIndex>, f32)

Change scaling factor/height of waves/items. If first argument is None, change for selected items.

ChangeVariableNameType(MessageTarget<VisibleItemIndex>, VariableNameType)

Change variable name type of waves/items. If first argument is None, change for selected items.

ForceVariableNameTypes(VariableNameType)

SetNameAlignRight(bool)

Set or unset right alignment of names

SetClockHighlightType(ClockHighlightType)

SetFillHighValues(bool)

ResetVariableFormat(DisplayedFieldRef)

CanvasScroll

Fields

delta: Vec2

viewport_idx: usize

CanvasZoom

Fields

mouse_ptr: Option<BigInt>

delta: f32

viewport_idx: usize

ZoomToRange

Fields

start: BigInt

end: BigInt

viewport_idx: usize

CursorSet(BigInt)

Set cursor at time.

SurferServerStatus(Instant, String, Status)

LoadFile(Utf8PathBuf, LoadOptions)

Load file from file path.

LoadWaveformFileFromUrl(String, LoadOptions)

Load file from URL.

LoadFromData(Vec<u8>, LoadOptions)

Load file from data.

LoadWasmTranslator(Utf8PathBuf)

Load a web assembly translator from file. This is loaded in addition to the translators loaded on startup.

LoadSpadeTranslator

Load a spade translator using the specified top and the specified state encoded as ron.

Fields

top: String

state: String

LoadCommandFile(Utf8PathBuf)

Load command file from file path.

LoadCommandFromData(Vec<u8>)

Load commands from data.

LoadCommandFileFromUrl(String)

Load command file from URL.

SetupCxxrtl(CxxrtlKind)

WaveHeaderLoaded(Instant, WaveSource, LoadOptions, HeaderResult)

Message sent when waveform file header is loaded.

WaveBodyLoaded(Instant, WaveSource, BodyResult)

Message sent when waveform file body is loaded.

WavesLoaded(WaveSource, WaveFormat, Box<WaveContainer>, LoadOptions)

SignalsLoaded(Instant, LoadSignalsResult)

TransactionStreamsLoaded(WaveSource, WaveFormat, TransactionContainer, LoadOptions)

Error(Error)

TranslatorLoaded(Box<DynTranslator>)

BlacklistTranslator(VariableRef, String)

Take note that the specified translator errored on a translates call on the specified variable

ShowCommandPrompt(Option<String>)

FileDropped(DroppedFile)

Message sent when file is loadedropped onto Surfer.

FileDownloaded(String, Bytes, LoadOptions)

Message sent when download of a waveform file is complete.

CommandFileDownloaded(String, Bytes)

Message sent when download of a command file is complete.

ReloadConfig

ReloadWaveform(bool)

SuggestReloadWaveform

Suggest reloading the current waveform as the file on disk has changed. This should first take the user’s confirmation before reloading the waveform. However, there is a configuration setting that the user can overwrite.

CloseReloadWaveformDialog

Close the ‘reload_waveform’ dialog. The reload_file boolean is the return value of the dialog. If do_not_show_again is true, the reload_file setting will be persisted.

Fields

reload_file: bool

do_not_show_again: bool

UpdateReloadWaveformDialog(ReloadWaveformDialog)

Update the waveform dialog UI with the provided dialog model.

OpenSiblingStateFile(bool)

SuggestOpenSiblingStateFile

CloseOpenSiblingStateFileDialog

Fields

load_state: bool

do_not_show_again: bool

UpdateOpenSiblingStateFileDialog(OpenSiblingStateFileDialog)

RemovePlaceholders

ZoomToFit

Fields

viewport_idx: usize

GoToStart

Fields

viewport_idx: usize

GoToEnd

Fields

viewport_idx: usize

GoToTime(Option<BigInt>, usize)

ToggleMenu

ToggleToolbar

ToggleOverview

ToggleStatusbar

ToggleIndices

ToggleDirection

ToggleEmptyScopes

ToggleParametersInScopes

ToggleSidePanel

ToggleItemSelected(Option<VisibleItemIndex>)

ToggleDefaultTimeline

ToggleTickLines

ToggleVariableTooltip

ToggleScopeTooltip

ToggleFullscreen

SetTimeUnit(TimeUnit)

Set which time unit to use.

SetTimeStringFormatting(Option<TimeStringFormatting>)

Set how to format the time strings. Passing None resets it to default.

SetHighlightFocused(bool)

CommandPromptClear

CommandPromptUpdate

Fields

suggestions: Vec<(String, Vec<bool>)>

CommandPromptPushPrevious(String)

SelectPrevCommand

SelectNextCommand

OpenFileDialog(OpenMode)

OpenCommandFileDialog

SaveStateFile(Option<PathBuf>)

LoadStateFile(Option<PathBuf>)

LoadState(Box<UserState>, Option<PathBuf>)

SetStateFile(PathBuf)

SetAboutVisible(bool)

SetKeyHelpVisible(bool)

SetGestureHelpVisible(bool)

SetQuickStartVisible(bool)

SetUrlEntryVisible(bool, Option<Box<dyn Fn(String) -> Message + Send + 'static>>)

SetLicenseVisible(bool)

SetRenameItemVisible(bool)

SetLogsVisible(bool)

SetMouseGestureDragStart(Option<Pos2>)

SetMeasureDragStart(Option<Pos2>)

SetFilterFocused(bool)

SetVariableNameFilterType(VariableNameFilterType)

SetVariableNameFilterCaseInsensitive(bool)

SetVariableIOFilter(VariableIOFilterType, bool)

SetVariableGroupByDirection(bool)

SetUIZoomFactor(f32)

SetPerformanceVisible(bool)

SetContinuousRedraw(bool)

SetCursorWindowVisible(bool)

SetHierarchyStyle(HierarchyStyle)

SetArrowKeyBindings(ArrowKeyBindings)

AddDivider(Option<String>, Option<VisibleItemIndex>)

AddTimeLine(Option<VisibleItemIndex>)

AddMarker

Fields

time: BigInt

name: Option<String>

move_focus: bool

SetMarker

Set a marker at a specific position. If it doesn’t exist, it will be created

Fields

id: u8

time: BigInt

RemoveMarker(u8)

Remove marker.

MoveMarkerToCursor(u8)

Set or move a marker to the position of the current cursor.

GoToCursorIfNotInView

Scroll in horizontal direction so that the cursor is visible.

GoToMarkerPosition(u8, usize)

MoveCursorToTransition

Fields

next: bool

variable: Option<VisibleItemIndex>

skip_zero: bool

MoveTransaction

Fields

next: bool

VariableValueToClipbord(MessageTarget<VisibleItemIndex>)

VariableNameToClipboard(MessageTarget<VisibleItemIndex>)

VariableFullNameToClipboard(MessageTarget<VisibleItemIndex>)

InvalidateDrawCommands

AddGraphic(GraphicId, Graphic)

RemoveGraphic(GraphicId)

VariableDragStarted(VisibleItemIndex)

Variable dragging messages

VariableDragTargetChanged(TargetPosition)

VariableDragFinished

AddDraggedVariables(Vec<VariableRef>)

UnpauseSimulation

Unpauses the simulation if the wave source supports this kind of interactivity. Otherwise does nothing

PauseSimulation

Pause the simulation if the wave source supports this kind of interactivity. Otherwise does nothing

ExpandDrawnItem

Expand the displayed item into subfields. Levels controls how many layers of subfields are expanded. 0 unexpands it completely

Fields

item: DisplayedItemRef

levels: usize

SetViewportStrategy(ViewportStrategy)

SetConfigFromString(String)

AddCharToPrompt(char)

Batch(Vec<Message>)

Run more than one message in sequence

AddViewport

RemoveViewport

SelectTheme(Option<String>)

Select Theme

Undo(usize)

Undo the last n changes

Redo(usize)

Redo the last n changes

DumpTree

GroupNew

Fields

name: Option<String>

before: Option<ItemIndex>

items: Option<Vec<DisplayedItemRef>>

GroupDissolve(Option<DisplayedItemRef>)

GroupFold(Option<DisplayedItemRef>)

GroupUnfold(Option<DisplayedItemRef>)

GroupFoldRecursive(Option<DisplayedItemRef>)

GroupUnfoldRecursive(Option<DisplayedItemRef>)

GroupFoldAll

GroupUnfoldAll

StartWcpServer

WCP Server

Fields

address: Option<String>

initiate: bool

StopWcpServer

SetupChannelWCP

Configures the WCP system to listen for messages over internal channels. This is used to start WCP on wasm

Exit

Exit the application. This has no effect on wasm and closes the window on other platforms

ExpandParameterSection

Should only used for tests. Expands the parameter section so that one can test the rendering.

AsyncDone(AsyncJob)

Trait Implementations

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Translator<VarId, ScopeId, Message> for AnyTranslator

fn name(&self) -> String

fn set_wave_source(&self, wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn translate( &self, variable: &VariableMeta, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info(&self, variable: &VariableMeta) -> Result<VariableInfo>

fn translates(&self, variable: &VariableMeta) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn reload(&self, sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for ClockTranslator

fn name(&self) -> String

fn translate( &self, variable: &VariableMeta<VarId, ScopeId>, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info(&self, _variable: &VariableMeta) -> Result<VariableInfo>

fn translates(&self, variable: &VariableMeta) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for EnumTranslator

fn name(&self) -> String

fn translate( &self, meta: &VariableMeta, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info(&self, _variable: &VariableMeta) -> Result<VariableInfo>

fn translates(&self, variable: &VariableMeta) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for PluginTranslator

fn name(&self) -> String

fn set_wave_source(&self, wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn translate( &self, variable: &VariableMeta<VarId, ScopeId>, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Result<VariableInfo>

fn translates( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for SignedFixedPointTranslator

fn name(&self) -> String

fn translate( &self, variable: &VariableMeta<VarId, ScopeId>, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info( &self, _: &VariableMeta<VarId, ScopeId>, ) -> Result<VariableInfo>

fn translates( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for SpadeTranslator

fn name(&self) -> String

fn translate( &self, variable: &VariableMeta, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info(&self, variable: &VariableMeta) -> Result<VariableInfo>

fn translates(&self, variable: &VariableMeta) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

fn reload(&self, sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

impl Translator<VarId, ScopeId, Message> for StringTranslator

fn name(&self) -> String

fn translate( &self, _variable: &VariableMeta, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info(&self, _variable: &VariableMeta) -> Result<VariableInfo>

fn translates(&self, variable: &VariableMeta) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.

impl Translator<VarId, ScopeId, Message> for UnsignedFixedPointTranslator

fn name(&self) -> String

fn translate( &self, variable: &VariableMeta<VarId, ScopeId>, value: &VariableValue, ) -> Result<TranslationResult>

fn variable_info( &self, _: &VariableMeta<VarId, ScopeId>, ) -> Result<VariableInfo>

fn translates( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Result<TranslationPreference>

Return [TranslationPreference] based on if the translator can handle this variable.

fn set_wave_source(&self, _wave_source: Option<WaveSource>)

Notify the translator that the wave source has changed to the specified source

fn reload(&self, _sender: Sender<Message>)

By default translators are stateless, but if they need to reload, they can do by defining this method. Long running translators should run the reloading in the background using perform_work

fn variable_name_info( &self, variable: &VariableMeta<VarId, ScopeId>, ) -> Option<VariableNameInfo>

Returns a VariableNameInfo about the specified variable which will be applied globally. Most translators should simply return None here, see the documentation VariableNameInfo for exceptions to this rule.