util

Documentation

Index

• Variables
• func ExtensionFromMimetype(mimetype string) string
• func GJSONPath(path ...string) string
• func MarshalAndDeleteEmpty(marshalable interface{}, paths []string) ([]byte, error)
• func RandomBytes(n int) []byte
• func RandomString(n int) string
• func RandomToken(namespace string, randomLength int) string
• type DualError
  • func NewDualError(high, low error) DualError
  • func (err DualError) Error() string
  • func (err DualError) Is(other error) bool
  • func (err DualError) Unwrap() error

Variables

var GJSONEscaper = strings.NewReplacer(
	`\`, `\\`,
	".", `\.`,
	"|", `\|`,
	"#", `\#`,
	"@", `\@`,
	"*", `\*`,
	"?", `\?`)

var MimeExtensionSanityOverrides = map[string]string{
	"image/png":  ".png",
	"image/webp": ".webp",
	"image/jpeg": ".jpg",
	"image/tiff": ".tiff",
	"image/heif": ".heic",
	"image/heic": ".heic",

	"audio/mpeg":  ".mp3",
	"audio/ogg":   ".ogg",
	"audio/webm":  ".webm",
	"audio/x-caf": ".caf",
	"video/mp4":   ".mp4",
	"video/mpeg":  ".mpeg",
	"video/webm":  ".webm",

	"text/plain": ".txt",
	"text/html":  ".html",

	"application/xml": ".xml",
}

MimeExtensionSanityOverrides includes extensions for various common mimetypes.

This is necessary because sometimes the OS mimetype database and Go interact in weird ways, which causes very obscure extensions to be first in the array for common mimetypes (e.g. image/jpeg -> .jpe, text/plain -> ,v).

Functions

func ExtensionFromMimetype

func ExtensionFromMimetype(mimetype string) string

func GJSONPath

func GJSONPath(path ...string) string

func MarshalAndDeleteEmpty

func MarshalAndDeleteEmpty(marshalable interface{}, paths []string) ([]byte, error)

MarshalAndDeleteEmpty marshals a JSON object, then uses gjson to delete empty objects at the given gjson paths.

This can be used as a convenient way to create a marshaler that omits empty non-pointer structs. See mautrix.RespSync for example.

func RandomBytes

func RandomBytes(n int) []byte

func RandomString

func RandomString(n int) string

RandomString generates a random string of the given length.

func RandomToken

func RandomToken(namespace string, randomLength int) string

Types

type DualError

type DualError struct {
	High error
	Low  error
}

func NewDualError

func NewDualError(high, low error) DualError

func (DualError) Error

func (err DualError) Error() string

func (DualError) Is

func (err DualError) Is(other error) bool

func (DualError) Unwrap

func (err DualError) Unwrap() error