util

Documentation

Index

• Constants
• func CommonPrefix(x, y string) string
• func HttpRequest(method, url string, body []byte, timeoutSeconds int, settings ...RequestSetup) (int, http.Header, []byte, error)
• func IsAsciiLetter(r rune) bool
• func MemoryUse() string
• func OpenBrowser(url string) error
• func RunShell(timeout time.Duration, wd string, envs []string, cmdAndArgs ...string) ([]byte, error)
• func RunShellCommand(timeout time.Duration, wd string, envs []string, cmd string, args ...string) ([]byte, error)
• func ServeFiles(dir, recommendedPort string, silentMode bool, goldsVersion string)
• func UncompressTarGzipData(data []byte) ([]byte, error)
• func WorkingDirectory() string
• func WriteHtmlEscapedBytes(w io.Writer, data []byte)
• func WriteUrlEscapedString(w io.StringWriter, data string)
• type HTMLEscapeWriter
  • func NewHTMLEscapeWriter(w io.Writer) *HTMLEscapeWriter
  • func (he *HTMLEscapeWriter) Write(data []byte) (n int, err error)
  • func (he *HTMLEscapeWriter) WriteString(data string) (n int, err error)
• type IndentWriter
  • func NewIndentWriter(w io.Writer, indent []byte) *IndentWriter
  • func (iw *IndentWriter) Write(s []byte) (int, error)
• type MarkdownRenderer
  • func (render *MarkdownRenderer) Render(w interface{ ... }, mdText string, indent string, removeLineCommonPrefix bool, ...)
• type RequestSetup
• type StopWatch
  • func NewStopWatch() *StopWatch
  • func (sw *StopWatch) Duration(reset bool) (d time.Duration)
• type URLEscapeWriter
  • func NewURLEscapeWriter(w io.StringWriter) *URLEscapeWriter
  • func (ue *URLEscapeWriter) WriteString(data string) (n int, err error)

Constants

const (
	Plain segmentKind = iota
	DirectLinkURL
	BracketText
)

Functions

func CommonPrefix

func CommonPrefix(x, y string) string

func HttpRequest

func HttpRequest(method, url string, body []byte, timeoutSeconds int, settings ...RequestSetup) (int, http.Header, []byte, error)

Returns: status code, headers, body, error

func IsAsciiLetter

func IsAsciiLetter(r rune) bool

func MemoryUse

func MemoryUse() string

func OpenBrowser

func OpenBrowser(url string) error

func RunShell

func RunShell(timeout time.Duration, wd string, envs []string, cmdAndArgs ...string) ([]byte, error)

func RunShellCommand

func RunShellCommand(timeout time.Duration, wd string, envs []string, cmd string, args ...string) ([]byte, error)

func ServeFiles

func ServeFiles(dir, recommendedPort string, silentMode bool, goldsVersion string)

func UncompressTarGzipData

func UncompressTarGzipData(data []byte) ([]byte, error)

This function is very simple. It is intended to get a single file.

func WorkingDirectory

func WorkingDirectory() string

func WriteHtmlEscapedBytes

func WriteHtmlEscapedBytes(w io.Writer, data []byte)

Please make sure w.Write never makes errors.

func WriteUrlEscapedString

func WriteUrlEscapedString(w io.StringWriter, data string)

Please make sure w.Write never makes errors.

Types

type HTMLEscapeWriter

type HTMLEscapeWriter struct {
	// contains filtered or unexported fields
}

func NewHTMLEscapeWriter

func NewHTMLEscapeWriter(w io.Writer) *HTMLEscapeWriter

func (*HTMLEscapeWriter) Write

func (he *HTMLEscapeWriter) Write(data []byte) (n int, err error)

func (*HTMLEscapeWriter) WriteString

func (he *HTMLEscapeWriter) WriteString(data string) (n int, err error)

Please make sure w.Write never makes errors.

type IndentWriter

type IndentWriter struct {
	// contains filtered or unexported fields
}

func NewIndentWriter

func NewIndentWriter(w io.Writer, indent []byte) *IndentWriter

func (*IndentWriter) Write

func (iw *IndentWriter) Write(s []byte) (int, error)

type MarkdownRenderer

type MarkdownRenderer struct {
	// contains filtered or unexported fields
}

A MarkdownRenderer is used to render docs and comments. It only builds links. Even for building links, it is not fully compatiable with https://go.dev/doc/comment.

## Test case 1

std lib type: io.Reader std lib funciton: fmt.Println current package type: StopWatch current package funciton: MemoryUse, [trimEndingSpaces] current package selector: [MarkdownRenderer.freeSegments], MarkdownRenderer.Render slibing package function: [app.Main], [app.run] slibing package slector: [server.TypeForListing.IsPointer], [server.TypeForListing.InCurrentPkg] module top-level package type: [*code.Package], module top-level package funciton: [code.ComparePackagePaths], [code.getMatchedPackages]

## Test case 2

The following texts are for testing purpose.

Test 1 bla bla. Ref: https://example.com/?a=b#something Test Test Test 222

func (*MarkdownRenderer) Render

func (render *MarkdownRenderer) Render(w interface {
	io.StringWriter
	io.Writer
}, mdText string, indent string, removeLineCommonPrefix bool, makeURL func(string) string)

type RequestSetup

type RequestSetup func(*http.Request, *http.Client)

type StopWatch

type StopWatch struct {
	// contains filtered or unexported fields
}

func NewStopWatch

func NewStopWatch() *StopWatch

Return an auto-start StopWatch.

func (*StopWatch) Duration

func (sw *StopWatch) Duration(reset bool) (d time.Duration)

Duration will reset the StopWatch.

type URLEscapeWriter

type URLEscapeWriter struct {
	// contains filtered or unexported fields
}

func NewURLEscapeWriter

func NewURLEscapeWriter(w io.StringWriter) *URLEscapeWriter

func (*URLEscapeWriter) WriteString

func (ue *URLEscapeWriter) WriteString(data string) (n int, err error)