format

Documentation

Overview

Package format provides formatting fuctions for different output format types.

Index

• Variables
• func NVL(s string, rest ...string) string
• type CSV
  • func (c *CSV) Channels(ctx context.Context, w io.Writer, u []slack.User, chans []slack.Channel) error
  • func (c *CSV) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error
  • func (c *CSV) Users(ctx context.Context, w io.Writer, users []slack.User) error
• type Formatter
  • func NewCSV(opts ...Option) Formatter
  • func NewJSON(opts ...Option) Formatter
  • func NewText(opts ...Option) Formatter
• type JSON
  • func (j JSON) Channels(ctx context.Context, w io.Writer, u []slack.User, chans []slack.Channel) error
  • func (j JSON) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error
  • func (j JSON) Users(ctx context.Context, w io.Writer, u []slack.User) error
• type Option
  • func JSONIndent(indent string) Option
  • func JSONPrefix(prefix string) Option
  • func TextNewMessageThreshold(d time.Duration) Option
• type Text
  • func (txt *Text) Channels(ctx context.Context, w io.Writer, u []slack.User, cc []slack.Channel) error
  • func (txt *Text) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error
  • func (txt *Text) Users(ctx context.Context, w io.Writer, u []slack.User) error
• type Type
  • func (e *Type) Set(v string) error
  • func (i Type) String() string
• type Types
  • func All() Types
  • func (tt Types) String() string

Variables

var Converters = make(map[Type]func(opts ...Option) Formatter)

var Descriptions = map[Type]string{
	CText: "Plain text format",
	CCSV:  "CSV format",
	CJSON: "JSON format",
}

Functions

func NVL

func NVL(s string, rest ...string) string

Types

type CSV

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

func (*CSV) Channels

func (c *CSV) Channels(ctx context.Context, w io.Writer, u []slack.User, chans []slack.Channel) error

func (*CSV) Conversation

func (c *CSV) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error

func (*CSV) Users

func (c *CSV) Users(ctx context.Context, w io.Writer, users []slack.User) error

type Formatter

type Formatter interface {
	Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error
	Channels(ctx context.Context, w io.Writer, u []slack.User, chans []slack.Channel) error
	Users(ctx context.Context, w io.Writer, u []slack.User) error
}

Formatter is a converter interface that each formatter must implement.

func NewCSV

func NewCSV(opts ...Option) Formatter

func NewJSON

func NewJSON(opts ...Option) Formatter

func NewText

func NewText(opts ...Option) Formatter

type JSON

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

JSON is the json formatter.

func (JSON) Channels

func (j JSON) Channels(ctx context.Context, w io.Writer, u []slack.User, chans []slack.Channel) error

func (JSON) Conversation

func (j JSON) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error

func (JSON) Users

func (j JSON) Users(ctx context.Context, w io.Writer, u []slack.User) error

type Option

type Option func(*options)

Option is the converter option.

func JSONIndent

func JSONIndent(indent string) Option

func JSONPrefix

func JSONPrefix(prefix string) Option

func TextNewMessageThreshold

func TextNewMessageThreshold(d time.Duration) Option

type Text

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

func (*Text) Channels

func (txt *Text) Channels(ctx context.Context, w io.Writer, u []slack.User, cc []slack.Channel) error

func (*Text) Conversation

func (txt *Text) Conversation(ctx context.Context, w io.Writer, u []slack.User, conv *types.Conversation) error

func (*Text) Users

func (txt *Text) Users(ctx context.Context, w io.Writer, u []slack.User) error

type Type

type Type int

Type is the converter type.

const (
	CUnknown Type = iota // Unknown converter type
	CText                // CText is the plain text converter
	CCSV                 // CCSV is the CSV converter
	CJSON                // CJSON is JSON format converter
)

func (*Type) Set

func (e *Type) Set(v string) error

func (Type) String

func (i Type) String() string

type Types

type Types []Type

Types is a list of converter types.

func All

func All() Types

func (Types) String

func (tt Types) String() string