watcherx

Documentation

Index

• Variables
• func Watch(ctx context.Context, u *url.URL, c EventChannel) error
• func WatchAndServeWS(ctx context.Context, u *url.URL, writer herodot.Writer) (http.HandlerFunc, error)
• func WatchDirectory(ctx context.Context, dir string, c EventChannel) error
• func WatchFile(ctx context.Context, file string, c EventChannel) error
• func WatchWebsocket(ctx context.Context, u *url.URL, c EventChannel) error
• type ChangeEvent
  • func (e *ChangeEvent) MarshalJSON() ([]byte, error)
  • func (e *ChangeEvent) Reader() io.Reader
  • func (e ChangeEvent) Source() string
• type ErrorEvent
  • func (e *ErrorEvent) MarshalJSON() ([]byte, error)
  • func (e *ErrorEvent) Reader() io.Reader
  • func (e ErrorEvent) Source() string
• type Event
• type EventChannel
• type RemoveEvent
  • func (e *RemoveEvent) MarshalJSON() ([]byte, error)
  • func (e *RemoveEvent) Reader() io.Reader
  • func (e RemoveEvent) Source() string

Variables

var ErrSchemeUnknown = &errSchemeUnknown{}

ErrSchemeUnknown is just for checking with errors.Is()

Functions

func Watch

func Watch(ctx context.Context, u *url.URL, c EventChannel) error

func WatchAndServeWS

func WatchAndServeWS(ctx context.Context, u *url.URL, writer herodot.Writer) (http.HandlerFunc, error)

func WatchDirectory

func WatchDirectory(ctx context.Context, dir string, c EventChannel) error

func WatchFile

func WatchFile(ctx context.Context, file string, c EventChannel) error

func WatchWebsocket

func WatchWebsocket(ctx context.Context, u *url.URL, c EventChannel) error

Types

type ChangeEvent

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

func (*ChangeEvent) MarshalJSON

func (e *ChangeEvent) MarshalJSON() ([]byte, error)

func (*ChangeEvent) Reader

func (e *ChangeEvent) Reader() io.Reader

func (ChangeEvent) Source

func (e ChangeEvent) Source() string

type ErrorEvent

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

func (*ErrorEvent) MarshalJSON

func (e *ErrorEvent) MarshalJSON() ([]byte, error)

func (*ErrorEvent) Reader

func (e *ErrorEvent) Reader() io.Reader

func (ErrorEvent) Source

func (e ErrorEvent) Source() string

type Event

type Event interface {
	Reader() io.Reader
	Source() string
	// contains filtered or unexported methods
}

type EventChannel

type EventChannel chan Event

type RemoveEvent

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

func (*RemoveEvent) MarshalJSON

func (e *RemoveEvent) MarshalJSON() ([]byte, error)

func (*RemoveEvent) Reader

func (e *RemoveEvent) Reader() io.Reader

func (RemoveEvent) Source

func (e RemoveEvent) Source() string