params

package
v1.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2026 License: MIT Imports: 12 Imported by: 0

README

params

Package params is a thread-safe map data structure used as a key-value store for all nodes in cy's node tree.

Documentation

Overview

Code generated by gen.go; DO NOT EDIT.

Index

Constants

View Source 
const (
	ParamAnimate                  = "animate"
	ParamAnimationDelay           = "animation-delay"
	ParamAnimationFps             = "animation-fps"
	ParamAnimations               = "animations"
	ParamColorError               = "color-error"
	ParamColorInfo                = "color-info"
	ParamColorMap                 = "color-map"
	ParamColorWarn                = "color-warn"
	ParamDataDirectory            = "data-directory"
	ParamDefaultFrame             = "default-frame"
	ParamDefaultShell             = "default-shell"
	ParamHistoryLimit             = "history-limit"
	ParamInputFindActiveStyle     = "input-find-active-style"
	ParamInputFindHighlightStyle  = "input-find-highlight-style"
	ParamInputFindInactiveStyle   = "input-find-inactive-style"
	ParamInputPreviewBorder       = "input-preview-border"
	ParamInputPreviewBorderFg     = "input-preview-border-fg"
	ParamInputPromptStyle         = "input-prompt-style"
	ParamInputThumbsHintStyle     = "input-thumbs-hint-style"
	ParamInputThumbsMatchStyle    = "input-thumbs-match-style"
	ParamInputThumbsPartialStyle  = "input-thumbs-partial-style"
	ParamNumSearchWorkers         = "num-search-workers"
	ParamRemovePaneOnExit         = "remove-pane-on-exit"
	ParamReplayCopyStyle          = "replay-copy-style"
	ParamReplayIncrementalStyle   = "replay-incremental-style"
	ParamReplayMatchActiveStyle   = "replay-match-active-style"
	ParamReplayMatchInactiveStyle = "replay-match-inactive-style"
	ParamReplayPlayStyle          = "replay-play-style"
	ParamReplaySelectionStyle     = "replay-selection-style"
	ParamReplayStatusBarStyle     = "replay-status-bar-style"
	ParamReplayTextCopyMode       = "replay-text-copy-mode"
	ParamReplayTextPlayMode       = "replay-text-play-mode"
	ParamReplayTextTimeMode       = "replay-text-time-mode"
	ParamReplayTextVisualMode     = "replay-text-visual-mode"
	ParamReplayTimeStyle          = "replay-time-style"
	ParamReplayVisualStyle        = "replay-visual-style"
	ParamSearchStatusBarStyle     = "search-status-bar-style"
	ParamSearchTextNoMatchesFound = "search-text-no-matches-found"
	ParamSearchTextSearching      = "search-text-searching"
	ParamSkipInput                = "---skip-input"
	ParamTerminalTextExited       = "terminal-text-exited"
	ParamTimestampFormat          = "timestamp-format"
	ParamUseSystemClipboard       = "use-system-clipboard"
)

Variables

This section is empty.

Functions

func Create added in v1.7.0 

func Create(filename string) (*params.DB, error)

Create creates a new parameter database with schema at the given path

func IsDefaultParam added in v1.8.0 

func IsDefaultParam(key string) bool

IsDefaultParam reports whether the given key is a default parameter.

func Open added in v1.7.0 

func Open(filename string) (*params.DB, error)

Open opens an existing parameter database at the given path

Types

type DefaultParam added in v0.2.0 

type DefaultParam struct {
	Name      string
	Docstring string
	Default   any
}

func DefaultParams added in v0.2.0 

func DefaultParams() []DefaultParam

type Parameters 

type Parameters struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func New 

func New() *Parameters

func (*Parameters) Animate added in v0.2.0 

func (p *Parameters) Animate() bool

func (*Parameters) AnimationDelay added in v1.10.0 

func (p *Parameters) AnimationDelay() int

func (*Parameters) AnimationFps added in v1.10.0 

func (p *Parameters) AnimationFps() int

func (*Parameters) Animations added in v0.2.0 

func (p *Parameters) Animations() []string

func (*Parameters) ColorError added in v0.12.0 

func (p *Parameters) ColorError() *style.Color

func (*Parameters) ColorInfo added in v0.12.0 

func (p *Parameters) ColorInfo() *style.Color

func (*Parameters) ColorMap added in v1.0.0 

func (p *Parameters) ColorMap() *style.ColorMap

func (*Parameters) ColorWarn added in v0.12.0 

func (p *Parameters) ColorWarn() *style.Color

func (*Parameters) DataDirectory added in v0.2.0 

func (p *Parameters) DataDirectory() string

func (*Parameters) DefaultFrame added in v0.2.0 

func (p *Parameters) DefaultFrame() string

func (*Parameters) DefaultShell added in v0.2.0 

func (p *Parameters) DefaultShell() string

func (*Parameters) Get 

func (p *Parameters) Get(key string) (value interface{}, ok bool)

func (*Parameters) HistoryLimit added in v1.10.0 

func (p *Parameters) HistoryLimit() int

func (*Parameters) InputFindActiveStyle added in v1.8.0 

func (p *Parameters) InputFindActiveStyle() *style.Style

func (*Parameters) InputFindHighlightStyle added in v1.8.0 

func (p *Parameters) InputFindHighlightStyle() *style.Style

func (*Parameters) InputFindInactiveStyle added in v1.8.0 

func (p *Parameters) InputFindInactiveStyle() *style.Style

func (*Parameters) InputPreviewBorder added in v0.12.0 

func (p *Parameters) InputPreviewBorder() *style.Border

func (*Parameters) InputPreviewBorderFg added in v0.12.0 

func (p *Parameters) InputPreviewBorderFg() *style.Color

func (*Parameters) InputPromptStyle added in v1.8.0 

func (p *Parameters) InputPromptStyle() *style.Style

func (*Parameters) InputThumbsHintStyle added in v1.8.0 

func (p *Parameters) InputThumbsHintStyle() *style.Style

func (*Parameters) InputThumbsMatchStyle added in v1.8.0 

func (p *Parameters) InputThumbsMatchStyle() *style.Style

func (*Parameters) InputThumbsPartialStyle added in v1.8.0 

func (p *Parameters) InputThumbsPartialStyle() *style.Style

func (*Parameters) NewChild 

func (p *Parameters) NewChild() *Parameters

func (*Parameters) NumSearchWorkers added in v0.10.0 

func (p *Parameters) NumSearchWorkers() int

func (*Parameters) RemovePaneOnExit added in v0.4.0 

func (p *Parameters) RemovePaneOnExit() bool

func (*Parameters) ReplayCopyStyle added in v1.8.0 

func (p *Parameters) ReplayCopyStyle() *style.Style

func (*Parameters) ReplayIncrementalStyle added in v1.8.0 

func (p *Parameters) ReplayIncrementalStyle() *style.Style

func (*Parameters) ReplayMatchActiveStyle added in v1.8.0 

func (p *Parameters) ReplayMatchActiveStyle() *style.Style

func (*Parameters) ReplayMatchInactiveStyle added in v1.8.0 

func (p *Parameters) ReplayMatchInactiveStyle() *style.Style

func (*Parameters) ReplayPlayStyle added in v1.8.0 

func (p *Parameters) ReplayPlayStyle() *style.Style

func (*Parameters) ReplaySelectionStyle added in v1.8.0 

func (p *Parameters) ReplaySelectionStyle() *style.Style

func (*Parameters) ReplayStatusBarStyle added in v1.8.0 

func (p *Parameters) ReplayStatusBarStyle() *style.Style

func (*Parameters) ReplayTextCopyMode added in v0.12.0 

func (p *Parameters) ReplayTextCopyMode() string

func (*Parameters) ReplayTextPlayMode added in v0.12.0 

func (p *Parameters) ReplayTextPlayMode() string

func (*Parameters) ReplayTextTimeMode added in v0.12.0 

func (p *Parameters) ReplayTextTimeMode() string

func (*Parameters) ReplayTextVisualMode added in v0.12.0 

func (p *Parameters) ReplayTextVisualMode() string

func (*Parameters) ReplayTimeStyle added in v1.8.0 

func (p *Parameters) ReplayTimeStyle() *style.Style

func (*Parameters) ReplayVisualStyle added in v1.8.0 

func (p *Parameters) ReplayVisualStyle() *style.Style

func (*Parameters) SearchStatusBarStyle added in v1.8.0 

func (p *Parameters) SearchStatusBarStyle() *style.Style

func (*Parameters) SearchTextNoMatchesFound added in v0.12.0 

func (p *Parameters) SearchTextNoMatchesFound() string

func (*Parameters) SearchTextSearching added in v0.12.0 

func (p *Parameters) SearchTextSearching() string

func (*Parameters) Set 

func (p *Parameters) Set(key string, value interface{}) error

func (*Parameters) SetAnimate added in v0.2.0 

func (p *Parameters) SetAnimate(value bool)

func (*Parameters) SetAnimationDelay added in v1.10.0 

func (p *Parameters) SetAnimationDelay(value int)

func (*Parameters) SetAnimationFps added in v1.10.0 

func (p *Parameters) SetAnimationFps(value int)

func (*Parameters) SetAnimations added in v0.2.0 

func (p *Parameters) SetAnimations(value []string)

func (*Parameters) SetColorError added in v0.12.0 

func (p *Parameters) SetColorError(value *style.Color)

func (*Parameters) SetColorInfo added in v0.12.0 

func (p *Parameters) SetColorInfo(value *style.Color)

func (*Parameters) SetColorMap added in v1.0.0 

func (p *Parameters) SetColorMap(value *style.ColorMap)

func (*Parameters) SetColorWarn added in v0.12.0 

func (p *Parameters) SetColorWarn(value *style.Color)

func (*Parameters) SetDataDirectory added in v0.2.0 

func (p *Parameters) SetDataDirectory(value string)

func (*Parameters) SetDefaultFrame added in v0.2.0 

func (p *Parameters) SetDefaultFrame(value string)

func (*Parameters) SetDefaultShell added in v0.2.0 

func (p *Parameters) SetDefaultShell(value string)

func (*Parameters) SetHistoryLimit added in v1.10.0 

func (p *Parameters) SetHistoryLimit(value int)

func (*Parameters) SetInputFindActiveStyle added in v1.8.0 

func (p *Parameters) SetInputFindActiveStyle(value *style.Style)

func (*Parameters) SetInputFindHighlightStyle added in v1.8.0 

func (p *Parameters) SetInputFindHighlightStyle(value *style.Style)

func (*Parameters) SetInputFindInactiveStyle added in v1.8.0 

func (p *Parameters) SetInputFindInactiveStyle(value *style.Style)

func (*Parameters) SetInputPreviewBorder added in v0.12.0 

func (p *Parameters) SetInputPreviewBorder(value *style.Border)

func (*Parameters) SetInputPreviewBorderFg added in v0.12.0 

func (p *Parameters) SetInputPreviewBorderFg(value *style.Color)

func (*Parameters) SetInputPromptStyle added in v1.8.0 

func (p *Parameters) SetInputPromptStyle(value *style.Style)

func (*Parameters) SetInputThumbsHintStyle added in v1.8.0 

func (p *Parameters) SetInputThumbsHintStyle(value *style.Style)

func (*Parameters) SetInputThumbsMatchStyle added in v1.8.0 

func (p *Parameters) SetInputThumbsMatchStyle(value *style.Style)

func (*Parameters) SetInputThumbsPartialStyle added in v1.8.0 

func (p *Parameters) SetInputThumbsPartialStyle(value *style.Style)

func (*Parameters) SetNumSearchWorkers added in v0.10.0 

func (p *Parameters) SetNumSearchWorkers(value int)

func (*Parameters) SetParent 

func (p *Parameters) SetParent(parent *Parameters)

func (*Parameters) SetRemovePaneOnExit added in v0.4.0 

func (p *Parameters) SetRemovePaneOnExit(value bool)

func (*Parameters) SetReplayCopyStyle added in v1.8.0 

func (p *Parameters) SetReplayCopyStyle(value *style.Style)

func (*Parameters) SetReplayIncrementalStyle added in v1.8.0 

func (p *Parameters) SetReplayIncrementalStyle(value *style.Style)

func (*Parameters) SetReplayMatchActiveStyle added in v1.8.0 

func (p *Parameters) SetReplayMatchActiveStyle(value *style.Style)

func (*Parameters) SetReplayMatchInactiveStyle added in v1.8.0 

func (p *Parameters) SetReplayMatchInactiveStyle(value *style.Style)

func (*Parameters) SetReplayPlayStyle added in v1.8.0 

func (p *Parameters) SetReplayPlayStyle(value *style.Style)

func (*Parameters) SetReplaySelectionStyle added in v1.8.0 

func (p *Parameters) SetReplaySelectionStyle(value *style.Style)

func (*Parameters) SetReplayStatusBarStyle added in v1.8.0 

func (p *Parameters) SetReplayStatusBarStyle(value *style.Style)

func (*Parameters) SetReplayTextCopyMode added in v0.12.0 

func (p *Parameters) SetReplayTextCopyMode(value string)

func (*Parameters) SetReplayTextPlayMode added in v0.12.0 

func (p *Parameters) SetReplayTextPlayMode(value string)

func (*Parameters) SetReplayTextTimeMode added in v0.12.0 

func (p *Parameters) SetReplayTextTimeMode(value string)

func (*Parameters) SetReplayTextVisualMode added in v0.12.0 

func (p *Parameters) SetReplayTextVisualMode(value string)

func (*Parameters) SetReplayTimeStyle added in v1.8.0 

func (p *Parameters) SetReplayTimeStyle(value *style.Style)

func (*Parameters) SetReplayVisualStyle added in v1.8.0 

func (p *Parameters) SetReplayVisualStyle(value *style.Style)

func (*Parameters) SetSearchStatusBarStyle added in v1.8.0 

func (p *Parameters) SetSearchStatusBarStyle(value *style.Style)

func (*Parameters) SetSearchTextNoMatchesFound added in v0.12.0 

func (p *Parameters) SetSearchTextNoMatchesFound(value string)

func (*Parameters) SetSearchTextSearching added in v0.12.0 

func (p *Parameters) SetSearchTextSearching(value string)

func (*Parameters) SetSkipInput added in v0.2.0 

func (p *Parameters) SetSkipInput(value bool)

func (*Parameters) SetTerminalTextExited added in v0.12.0 

func (p *Parameters) SetTerminalTextExited(value string)

func (*Parameters) SetTimestampFormat added in v0.12.0 

func (p *Parameters) SetTimestampFormat(value string)

func (*Parameters) SetUseSystemClipboard added in v1.7.0 

func (p *Parameters) SetUseSystemClipboard(value bool)

func (*Parameters) SkipInput added in v0.2.0 

func (p *Parameters) SkipInput() bool

func (*Parameters) TerminalTextExited added in v0.12.0 

func (p *Parameters) TerminalTextExited() string

func (*Parameters) TimestampFormat added in v0.12.0 

func (p *Parameters) TimestampFormat() string

func (*Parameters) UseSystemClipboard added in v1.7.0 

func (p *Parameters) UseSystemClipboard() bool

type PersistentStore added in v1.7.0 

type PersistentStore struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

PersistentStore provides persistent parameter storage using SQLite

func NewPersistentStore added in v1.7.0 

func NewPersistentStore(
	vm *janet.VM,
	stateDir string,
) (*PersistentStore, error)

NewPersistentStore creates a new persistent parameter store in the given state directory. If stateDir is empty, uses an in-memory database.

func (*PersistentStore) Get added in v1.7.0 

func (p *PersistentStore) Get(
	ctx context.Context,
	key string,
) (*janet.Value, bool, error)

Get retrieves a parameter value from the persistent store

func (*PersistentStore) Set added in v1.7.0 

func (p *PersistentStore) Set(
	ctx context.Context,
	key string,
	value *janet.Value,
) error

Set stores a parameter value in the persistent store

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.