flags

Documentation

Index

• Variables
• func ModeStrings() []string
• func ProtocolStrings() []string
• type Mode
  • func ModeString(s string) (Mode, error)
  • func ModeValues() []Mode
  • func (i Mode) IsAMode() bool
  • func (i Mode) MarshalText() ([]byte, error)
  • func (i Mode) String() string
  • func (i *Mode) UnmarshalText(text []byte) error
• type Protocol
  • func ProtocolString(s string) (Protocol, error)
  • func ProtocolValues() []Protocol
  • func (i Protocol) IsAProtocol() bool
  • func (i Protocol) MarshalText() ([]byte, error)
  • func (i Protocol) String() string
  • func (i *Protocol) UnmarshalText(text []byte) error
• type Set
  • func NewSet() *Set
  • func (s *Set) ClientPort() uint
  • func (s *Set) Command() (string, []string)
  • func (s *Set) CommandArgs() string
  • func (s *Set) HasCommand() bool
  • func (s *Set) HostAddress() string
  • func (s *Set) LogFileAppend() bool
  • func (s *Set) LogFileFormat() string
  • func (s *Set) LogFileLevel() zerolog.Level
  • func (s *Set) LogFilePath() string
  • func (s *Set) LogLevel() zerolog.Level
  • func (s *Set) LogMessageTwice() bool
  • func (s *Set) LogStdFormat() string
  • func (s *Set) MaxFieldDisplayLength() int
  • func (s *Set) MessageDir() string
  • func (s *Set) Mode() Mode
  • func (s *Set) ModeConnectsToClient() bool
  • func (s *Set) ModeConnectsToServer() bool
  • func (s *Set) Protocol() Protocol
  • func (s *Set) RequestPath() string
  • func (s *Set) ServerPort() int
  • func (s *Set) Validate() error
  • func (s *Set) ValidateLogging() error
  • func (s *Set) Version() bool
  • func (s *Set) WebPort() uint

Variables

var ErrHelp = flag.ErrHelp

ErrHelp should be visible without drilling into the original flag package.

Functions

func ModeStrings

func ModeStrings() []string

ModeStrings returns a slice of all String values of the enum

func ProtocolStrings

func ProtocolStrings() []string

ProtocolStrings returns a slice of all String values of the enum

Types

type Mode

type Mode uint

Mode is the operation modeFlag.

const (
	// Client mode pretends to be an LSP to a VSCode client.
	// In this mode flags must provide connection data to VSCode.
	// The required flag must specify the client connection (e.g. -clientPort).
	Client Mode = iota

	// Nexus mode uses LSP as server and pretends to be LSP to VSCode client.
	// In this mode communication between the two is passed through and logged.
	Nexus

	// Server mode tests the LSP as a server, pretending to be a VSCode client.
	// In this mode flags must provide connection data to the LSP.
	// The required flag must specify the server connection (e.g. -serverPort).
	Server
)

func ModeString

func ModeString(s string) (Mode, error)

ModeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ModeValues

func ModeValues() []Mode

ModeValues returns all values of the enum

func (Mode) IsAMode

func (i Mode) IsAMode() bool

IsAMode returns "true" if the value is listed in the enum definition. "false" otherwise

func (Mode) MarshalText

func (i Mode) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Mode

func (Mode) String

func (i Mode) String() string

func (*Mode) UnmarshalText

func (i *Mode) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Mode

type Protocol

type Protocol uint

Protocol is the LSP communications protocolFlag.

const (
	// Sub protocol runs LSP as sub-process and communicate via it's stdin/stdout.
	Sub Protocol = iota

	// TCP protocol communicates with LSP via TCP ports.
	TCP
)

func ProtocolString

func ProtocolString(s string) (Protocol, error)

ProtocolString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ProtocolValues

func ProtocolValues() []Protocol

ProtocolValues returns all values of the enum

func (Protocol) IsAProtocol

func (i Protocol) IsAProtocol() bool

IsAProtocol returns "true" if the value is listed in the enum definition. "false" otherwise

func (Protocol) MarshalText

func (i Protocol) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Protocol

func (Protocol) String

func (i Protocol) String() string

func (*Protocol) UnmarshalText

func (i *Protocol) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Protocol

type Set

type Set struct {
	*flag.FlagSet
	// contains filtered or unexported fields
}

func NewSet

func NewSet() *Set

func (*Set) ClientPort

func (s *Set) ClientPort() uint

func (*Set) Command

func (s *Set) Command() (string, []string)

func (*Set) CommandArgs

func (s *Set) CommandArgs() string

func (*Set) HasCommand

func (s *Set) HasCommand() bool

func (*Set) HostAddress

func (s *Set) HostAddress() string

func (*Set) LogFileAppend

func (s *Set) LogFileAppend() bool

func (*Set) LogFileFormat

func (s *Set) LogFileFormat() string

func (*Set) LogFileLevel

func (s *Set) LogFileLevel() zerolog.Level

func (*Set) LogFilePath

func (s *Set) LogFilePath() string

func (*Set) LogLevel

func (s *Set) LogLevel() zerolog.Level

func (*Set) LogMessageTwice

func (s *Set) LogMessageTwice() bool

func (*Set) LogStdFormat

func (s *Set) LogStdFormat() string

func (*Set) MaxFieldDisplayLength

func (s *Set) MaxFieldDisplayLength() int

func (*Set) MessageDir

func (s *Set) MessageDir() string

func (*Set) Mode

func (s *Set) Mode() Mode

func (*Set) ModeConnectsToClient

func (s *Set) ModeConnectsToClient() bool

func (*Set) ModeConnectsToServer

func (s *Set) ModeConnectsToServer() bool

func (*Set) Protocol

func (s *Set) Protocol() Protocol

func (*Set) RequestPath

func (s *Set) RequestPath() string

func (*Set) ServerPort

func (s *Set) ServerPort() int

func (*Set) Validate

func (s *Set) Validate() error

func (*Set) ValidateLogging

func (s *Set) ValidateLogging() error

func (*Set) Version

func (s *Set) Version() bool

func (*Set) WebPort

func (s *Set) WebPort() uint