waitlivemsg

Documentation

Index

• type Message
  • func EmptyLine() *Message
  • func NewMessage(text string) *Message
  • func (m *Message) End()
  • func (m *Message) GetText() string
  • func (m *Message) PlayText(text string)
  • func (m *Message) StopText(text string)
• type WaitLiveMsg
  • func New(ws *uilive.Writer) *WaitLiveMsg
  • func (w *WaitLiveMsg) AddMessage(msg *Message)
  • func (w *WaitLiveMsg) Duration() time.Duration
  • func (w *WaitLiveMsg) GetMessages() []*Message
  • func (w *WaitLiveMsg) RemoveMessage(msg *Message)
  • func (w *WaitLiveMsg) ResetDuration()
  • func (w *WaitLiveMsg) ResetMessages()
  • func (w *WaitLiveMsg) SetMessage(msg *Message)
  • func (w *WaitLiveMsg) SetMessages(msgs []*Message)
  • func (w *WaitLiveMsg) SetStream(ws *uilive.Writer)
  • func (w *WaitLiveMsg) Stop()
  • func (w *WaitLiveMsg) Wait()

Types

type Message

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

Message to print

func EmptyLine

func EmptyLine() *Message

EmptyLine creates a Message with an empty line it has the side-effect of using no symbols as prefixes

func NewMessage

func NewMessage(text string) *Message

NewMessage creates a Message with a given text

func (*Message) End

func (m *Message) End()

End of live message

func (*Message) GetText

func (m *Message) GetText() string

GetText of the message

func (*Message) PlayText

func (m *Message) PlayText(text string)

PlayText as a live message

func (*Message) StopText

func (m *Message) StopText(text string)

StopText of the live messages

type WaitLiveMsg

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

WaitLiveMsg is used for "waiting" live message

func New

func New(ws *uilive.Writer) *WaitLiveMsg

New creates a WaitLiveMsg

func (*WaitLiveMsg) AddMessage

func (w *WaitLiveMsg) AddMessage(msg *Message)

AddMessage to display

func (*WaitLiveMsg) Duration

func (w *WaitLiveMsg) Duration() time.Duration

Duration in seconds

func (*WaitLiveMsg) GetMessages

func (w *WaitLiveMsg) GetMessages() []*Message

GetMessages displayed

func (*WaitLiveMsg) RemoveMessage

func (w *WaitLiveMsg) RemoveMessage(msg *Message)

RemoveMessage from the messages slice

func (*WaitLiveMsg) ResetDuration

func (w *WaitLiveMsg) ResetDuration()

ResetDuration to restart counter

func (*WaitLiveMsg) ResetMessages

func (w *WaitLiveMsg) ResetMessages()

ResetMessages to display

func (*WaitLiveMsg) SetMessage

func (w *WaitLiveMsg) SetMessage(msg *Message)

SetMessage to display

func (*WaitLiveMsg) SetMessages

func (w *WaitLiveMsg) SetMessages(msgs []*Message)

SetMessages to display

func (*WaitLiveMsg) SetStream

func (w *WaitLiveMsg) SetStream(ws *uilive.Writer)

SetStream to output to

func (*WaitLiveMsg) Stop

func (w *WaitLiveMsg) Stop()

Stop the waiting message

func (*WaitLiveMsg) Wait

func (w *WaitLiveMsg) Wait()

Wait starts the waiting message