cplogs

package

v1.24.19 Latest Latest Go to latest Published: Mar 7, 2021 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const DBSchema = `` /* 449-byte string literal not displayed */

This section is empty.

func AddEntry(entry *LogEntry) error

AddEntry adds a entry to the database, also generating a "LocalID" for this entry

func RegisterActionFormat(format *ActionFormat) string

RegisterActionFormat sets up a action format, call this in your package init function

func RetryAddEntry(entry *LogEntry)

RetryAddEntry will etry AddEntry until it suceeds or 60 seconds has elapsed

type ActionFormat struct {
	Key          string
	FormatString string
	Found        bool
}

type LogAction struct {
	Key       string
	FormatStr string
	Params    []*Param
}

func (l *LogAction) String() string

type LogEntry struct {
	GuildID int64
	LocalID int64

	AuthorID       int64
	AuthorUsername string

	Action *LogAction

	CreatedAt time.Time
}

func GetEntries(guildID int64, limit int, before int64) ([]*LogEntry, error)

func NewEntry(guildID int64, authorID int64, authorUsername string, action string, params ...*Param) *LogEntry

type Param struct {
	Type  ParamType
	Value interface{}
}

type ParamType uint8

const (
	ParamTypeNone   ParamType = 0
	ParamTypeInt    ParamType = 1
	ParamTypeString ParamType = 2
)