progress

Documentation

Index

• func Done() tea.Msg
• func Subscribe(obs Observable, handler HandlerFunc) rx.Subscription
• func SubscribeMessage(obs Observable, handler MessageFunc) rx.Subscription
• func SubscribeTotal(obs Observable, handler TotalFunc) rx.Subscription
• type DoneMsg
• type Event
  • func (e Event) ProgressMsg() ProgressMsg
• type File
  • func Open(fs afero.Fs, name string) (File, error)
• type Func
• type HandlerFunc
  • func ChannelHandler(stream chan<- *Event, errs chan<- error) HandlerFunc
  • func Lift[F Func](fn F) HandlerFunc
  • func TeaHandler(prog *tea.Program) HandlerFunc
  • func (fn HandlerFunc) OnComplete()
  • func (fn HandlerFunc) OnError(err error)
  • func (fn HandlerFunc) OnNext(e Event)
  • func (fn HandlerFunc) SubscribeTo(obs Observable) rx.Subscription
• type MessageEvent
• type MessageFunc
  • func (fn MessageFunc) Handler() HandlerFunc
  • func (fn MessageFunc) OnComplete()
  • func (fn MessageFunc) OnError(err error)
  • func (fn MessageFunc) OnNext(e Event)
  • func (fn MessageFunc) SubscribeTo(obs Observable) rx.Subscription
• type MessageObservable
• type Model
  • func NewModel() Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string
• type Observable
• type ProgressMsg
  • func ToMsg(e *Event) ProgressMsg
• type Reader
  • func NewReader(r io.Reader, total int) Reader
• type State
• type Subject
  • func NewSubject(total int) Subject
• type TotalEvent
  • func (e TotalEvent) Percent() float64
• type TotalFunc
  • func (fn TotalFunc) Handler() HandlerFunc
  • func (TotalFunc) OnComplete()
  • func (fn TotalFunc) OnError(err error)
  • func (r TotalFunc) OnNext(e Event)
  • func (fn TotalFunc) SubscribeTo(obs Observable) rx.Subscription
• type TotalObservable
• type Writer
  • func NewWriter(w io.Writer, total int) Writer

Functions

func Done

func Done() tea.Msg

func Subscribe

func Subscribe(obs Observable, handler HandlerFunc) rx.Subscription

func SubscribeMessage

func SubscribeMessage(obs Observable, handler MessageFunc) rx.Subscription

func SubscribeTotal

func SubscribeTotal(obs Observable, handler TotalFunc) rx.Subscription

Types

type DoneMsg

type DoneMsg struct{}

type Event

type Event struct {
	MessageEvent
	TotalEvent
}

func (Event) ProgressMsg

func (e Event) ProgressMsg() ProgressMsg

type File

type File interface {
	afero.File
	Reader
}

func Open

func Open(fs afero.Fs, name string) (File, error)

type Func

type Func interface {
	~func(*Event, error) | ~func(float64, error) | ~func(string, error)
}

type HandlerFunc

type HandlerFunc func(*Event, error)

func ChannelHandler

func ChannelHandler(stream chan<- *Event, errs chan<- error) HandlerFunc

func Lift

func Lift[F Func](fn F) HandlerFunc

func TeaHandler

func TeaHandler(prog *tea.Program) HandlerFunc

func (HandlerFunc) OnComplete

func (fn HandlerFunc) OnComplete()

OnComplete implements rx.Observer.

func (HandlerFunc) OnError

func (fn HandlerFunc) OnError(err error)

OnError implements rx.Observer.

func (HandlerFunc) OnNext

func (fn HandlerFunc) OnNext(e Event)

OnNext implements rx.Observer.

func (HandlerFunc) SubscribeTo

func (fn HandlerFunc) SubscribeTo(obs Observable) rx.Subscription

type MessageEvent

type MessageEvent struct {
	Message string
}

type MessageFunc

type MessageFunc func(string, error)

func (MessageFunc) Handler

func (fn MessageFunc) Handler() HandlerFunc

func (MessageFunc) OnComplete

func (fn MessageFunc) OnComplete()

OnComplete implements rx.Observer.

func (MessageFunc) OnError

func (fn MessageFunc) OnError(err error)

OnError implements rx.Observer.

func (MessageFunc) OnNext

func (fn MessageFunc) OnNext(e Event)

OnNext implements rx.Observer.

func (MessageFunc) SubscribeTo

func (fn MessageFunc) SubscribeTo(obs Observable) rx.Subscription

type MessageObservable

type MessageObservable interface {
	rx.Observable[string]
}

type Model

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

func NewModel

func NewModel() Model

func (Model) Init

func (m Model) Init() tea.Cmd

Init implements tea.Model.

func (Model) Update

func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)

Update implements tea.Model.

func (Model) View

func (m Model) View() string

View implements tea.Model.

type Observable

type Observable interface {
	rx.Observable[Event]
}

type ProgressMsg

type ProgressMsg float64

func ToMsg

func ToMsg(e *Event) ProgressMsg

type Reader

type Reader interface {
	Observable
	io.Reader
}

func NewReader

func NewReader(r io.Reader, total int) Reader

type State

type State interface {
	Advance(int) TotalEvent
}

type Subject

type Subject interface {
	rx.Subject[Event]
	State
}

func NewSubject

func NewSubject(total int) Subject

type TotalEvent

type TotalEvent struct {
	Current int
	Total   int
}

func (TotalEvent) Percent

func (e TotalEvent) Percent() float64

type TotalFunc

type TotalFunc func(float64, error)

func (TotalFunc) Handler

func (fn TotalFunc) Handler() HandlerFunc

func (TotalFunc) OnComplete

func (TotalFunc) OnComplete()

OnComplete implements rx.Observer.

func (TotalFunc) OnError

func (fn TotalFunc) OnError(err error)

OnError implements rx.Observer.

func (TotalFunc) OnNext

func (r TotalFunc) OnNext(e Event)

OnNext implements rx.Observer.

func (TotalFunc) SubscribeTo

func (fn TotalFunc) SubscribeTo(obs Observable) rx.Subscription

type TotalObservable

type TotalObservable interface {
	rx.Observable[float64]
}

type Writer

type Writer interface {
	Observable
	io.Writer
}

func NewWriter

func NewWriter(w io.Writer, total int) Writer