xlsxer

README

xlsxer

Create Excel from struct or a slice of structs in Go

Documentation

Index

• Variables
• type NoMarshalFuncError
  • func (e NoMarshalFuncError) Error() string
• type NoUnmarshalFuncError
  • func (e NoUnmarshalFuncError) Error() string
• type Normalizer
  • func DefaultNameNormalizer() Normalizer
• type TypeMarshaller
• type TypeUnmarshalCSVWithFields
• type TypeUnmarshaller

Variables

var FieldsCombiner = "."

FieldSeperator defines how to combine parent struct with child struct

var TagName = "xlsx"

TagName defines key in the struct field's tag to scan

var TagSeparator = ","

TagSeparator defines seperator string for multiple xlsx tags in struct fields

Types

type NoMarshalFuncError

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

NoMarshalFuncError is the custom error type to be raised in case there is no marshal function defined on type

func (NoMarshalFuncError) Error

func (e NoMarshalFuncError) Error() string

type NoUnmarshalFuncError

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

NoUnmarshalFuncError is the custom error type to be raised in case there is no unmarshal function defined on type

func (NoUnmarshalFuncError) Error

func (e NoUnmarshalFuncError) Error() string

type Normalizer

type Normalizer func(string) string

Normalizer is a function that takes and returns a string. It is applied to struct and header field values before they are compared. It can be used to alter names for comparison. For instance, you could allow case insensitive matching or convert '-' to '_'.

func DefaultNameNormalizer

func DefaultNameNormalizer() Normalizer

DefaultNameNormalizer is a nop Normalizer.

type TypeMarshaller

type TypeMarshaller interface {
	MarshalCSV() (string, error)
}

TypeMarshaller is implemented by any value that has a MarshalCSV method This converter is used to convert the value to it string representation

type TypeUnmarshalCSVWithFields

type TypeUnmarshalCSVWithFields interface {
	UnmarshalCSVWithFields(key, value string) error
}

TypeUnmarshalCSVWithFields can be implemented on whole structs to allow for whole structures to customized internal vs one off fields

type TypeUnmarshaller

type TypeUnmarshaller interface {
	UnmarshalCSV(string) error
}

TypeUnmarshaller is implemented by any value that has an UnmarshalCSV method This converter is used to convert a string to your value representation of that string