utils

Documentation

Index

• Constants
• func DecorateText(s string, msgType MessageType) string
• func DetectContentType(fname string) (interface{}, error)
• func DownloadImage(url string) (*os.File, error)
• func FormatTime(d time.Duration) string
• func HexToRGBA(x string) color.NRGBA
• func IsValidUrl(uri string) bool
• type MessageType
• type Spinner
  • func NewSpinner(msg string, d time.Duration) *Spinner
  • func (s *Spinner) RestoreCursor()
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop()

Constants

const (
	DefaultColor = "\x1b[0m"
	StatusColor  = "\x1b[36m"
	SuccessColor = "\x1b[32m"
	ErrorColor   = "\x1b[31m"
)

Colors used accross the CLI application.

Functions

func DecorateText

func DecorateText(s string, msgType MessageType) string

DecorateText shows the message types in different colors.

func DetectContentType

func DetectContentType(fname string) (interface{}, error)

DetectContentType detects the file type by reading MIME type information of the file content.

func DownloadImage

func DownloadImage(url string) (*os.File, error)

DownloadImage downloads the image from the internet and saves it into a temporary file.

func FormatTime

func FormatTime(d time.Duration) string

FormatTime formats time.Duration output to a human readable value.

func HexToRGBA

func HexToRGBA(x string) color.NRGBA

HexToRGBA converts a color expressed as hexadecimal string to RGBA color.

func IsValidUrl

func IsValidUrl(uri string) bool

IsValidUrl tests a string to determine if it is a well-structured url or not.

Types

type MessageType

type MessageType int

MessageType is a custom type used as a placeholder for various message types.

const (
	DefaultMessage MessageType = iota
	SuccessMessage
	ErrorMessage
	StatusMessage
)

The message types used accross the CLI application.

type Spinner

type Spinner struct {
	StopMsg string
	// contains filtered or unexported fields
}

Spinner initializes the progress indicator.

func NewSpinner

func NewSpinner(msg string, d time.Duration) *Spinner

NewSpinner instantiates a new progress indicator.

func (*Spinner) RestoreCursor

func (s *Spinner) RestoreCursor()

RestoreCursor restores back the cursor visibility.

func (*Spinner) Start

func (s *Spinner) Start()

Start starts the progress indicator.

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop stops the progress indicator.