ux

Documentation

Overview

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022, Ava Labs, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

• func ConvertToStringWithThousandSeparator(input uint64) string
• func FormatDuration(d time.Duration) string
• func NewUserLog(log logging.Logger, userwriter io.Writer)
• func PrintEndpointTables(clusterInfo *rpcpb.ClusterInfo) error
• func PrintTableEndpoints(clusterInfo *rpcpb.ClusterInfo, codespaceURLs bool) error
• func PrintWait(cancel chan struct{})
• func SpinComplete(s *ysmrr.Spinner)
• func SpinFailWithError(s *ysmrr.Spinner, txt string, err error)
• type UserLog
  • func (ul *UserLog) GreenCheckmarkToUser(msg string, args ...interface{})
  • func (ul *UserLog) Info(msg string, args ...interface{})
  • func (ul *UserLog) PrintLineSeparator()
  • func (ul *UserLog) PrintToUser(msg string, args ...interface{})
  • func (ul *UserLog) RedXToUser(msg string, args ...interface{})
• type UserSpinner
  • func NewUserSpinner() *UserSpinner
  • func (us *UserSpinner) SpinToUser(msg string, args ...interface{}) *ysmrr.Spinner
  • func (us *UserSpinner) Stop()

Functions

func ConvertToStringWithThousandSeparator

func ConvertToStringWithThousandSeparator(input uint64) string

func FormatDuration

func FormatDuration(d time.Duration) string

FormatDuration returns a user friendly string for a duration

func NewUserLog

func NewUserLog(log logging.Logger, userwriter io.Writer)

func PrintEndpointTables

func PrintEndpointTables(clusterInfo *rpcpb.ClusterInfo) error

PrintEndpointTables prints the endpoints coming from the healthy call

func PrintTableEndpoints

func PrintTableEndpoints(clusterInfo *rpcpb.ClusterInfo, codespaceURLs bool) error

func PrintWait

func PrintWait(cancel chan struct{})

PrintWait does some dot printing to entertain the user

func SpinComplete

func SpinComplete(s *ysmrr.Spinner)

func SpinFailWithError

func SpinFailWithError(s *ysmrr.Spinner, txt string, err error)

Types

type UserLog

type UserLog struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

var Logger *UserLog

func (*UserLog) GreenCheckmarkToUser

func (ul *UserLog) GreenCheckmarkToUser(msg string, args ...interface{})

GreenCheckmarkToUser prints a green checkmark to the user before the message

func (*UserLog) Info

func (ul *UserLog) Info(msg string, args ...interface{})

Info prints to the log file

func (*UserLog) PrintLineSeparator

func (ul *UserLog) PrintLineSeparator()

func (*UserLog) PrintToUser

func (ul *UserLog) PrintToUser(msg string, args ...interface{})

PrintToUser prints msg directly on the screen, but also to log file

func (*UserLog) RedXToUser

func (ul *UserLog) RedXToUser(msg string, args ...interface{})

type UserSpinner

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

func NewUserSpinner

func NewUserSpinner() *UserSpinner

func (*UserSpinner) SpinToUser

func (us *UserSpinner) SpinToUser(msg string, args ...interface{}) *ysmrr.Spinner

func (*UserSpinner) Stop

func (us *UserSpinner) Stop()