exl

type ContentError struct {
	FieldErrors  []FieldError
	LimitReached bool
}

type ExcelUnmarshalParameters struct {
	// See ReadConfig.TrimSpace
	TrimSpace bool
	// See xlsx.File.Date1904
	Date1904 bool
	// See ReadConfig.FallbackDateFormats
	FallbackDateFormats []string
}

type ExcelUnmarshaler interface {
	UnmarshalExcel(cell *xlsx.Cell, params *ExcelUnmarshalParameters) error
}

type FieldError struct {
	RowIndex     int // 0-based row index. Printed as 1-based row number in error text.
	ColumnIndex  int // 0-based column index.
	ColumnHeader string
	Err          error
}

type FieldInfo struct {
	Header string
	// contains filtered or unexported fields
}

type ReadConfig struct {
	// The tag name to use when looking for fields in the target struct.
	// Defaults to "excel".
	TagName string
	// Name of the worksheet to be read. Takes precedence over SheetIndex.
	// Defaults to ""
	SheetName string
	// The index of the worksheet to be read.
	// Defaults to 0, the first worksheet.
	SheetIndex int
	// The row index at which the column headers are read from.
	// Zero-based, defaults to 0.
	HeaderRowIndex int
	// Start the data reading at this row.
	// The header row counts as row.
	// Zero-based, defaults to 1.
	DataStartRowIndex int
	// Configure the default string unmarshaler to trim space after reading a cell.
	// Does not impact any other default unmarshaler,
	// but is available to custom unmarshalers via ExcelUnmarshalParameters.TrimSpace.
	// Defaults to false.
	TrimSpace bool
	// Fallback date formats for date parsing.
	// If an Excel cell is to be unmarshalled into a date,
	// and that cell is either not formatted as Date or contains raw text
	// (which can happen if Excel does not correctly recognize the date format)
	// then these formats are used in the order specified to try and parse
	// the raw cell value into a date.
	// There are no fallback formats configured by default.
	FallbackDateFormats []string
	// Skip reading columns for which no target field is found.
	// Defaults to true.
	SkipUnknownColumns bool
	// Skip reading columns, if there is a target field,
	// but the target type is unsupported
	// or caused an error when determining the unmarshaler to use.
	// Defaults to false.
	SkipUnknownTypes bool
	// Configure how errors during unmarshalling are handled.
	// Unmarshalling errors are e.g. invalid number formats in the cell,
	// date parsing with invalid input,
	// or attempting to unmarshal non-numeric text into a numeric field.
	// Defaults to UnmarshalErrorAbort.
	UnmarshalErrorHandling UnmarshalErrorHandling
	// If UnmarshalErrorHandling is configured as UnmarshalErrorCollect,
	// this option limits the number of errors which are collected before
	// parsing is aborted.
	// Configure a limit of 0 to collect all errors, without upper limit.
	// Defaults to 10.
	MaxUnmarshalErrors uint64
	// Handler function for unmarshal errors during row parsing.
	// Takes precedence over all UnmarshalErrorHandling except
	// UnmarshalErrorIgnore.
	// Defaults to nil.
	RowUnmarshalErrorHandler RowUnmarshalErrorHandlerFunc
	// Handler function for columns not present in struct.
	// Defaults to nil.
	UnusedColumnsHandler UnusedColumnsHandlerFunc
}

type ReadConfigurator interface{ ReadConfigure(rc *ReadConfig) }

type RowUnmarshalErrorHandlerFunc func(*xlsx.Cell, *reflect.Value, FieldInfo)

type UnmarshalErrorHandling uint8

type UnmarshalExcelFunc func(destValue reflect.Value, cell *xlsx.Cell, params *ExcelUnmarshalParameters) error

type UnusedColumnsHandlerFunc func(*xlsx.Cell, *reflect.Value, FieldInfo)

type WriteConfig struct {
	// Name of the Sheet created to hold the data.
	// Defaults to "Sheet1".
	SheetName string
	// Name of the tag on the data struct to configure column headers
	// and whether to ignore any fields.
	// Defaults to "excel".
	TagName string
	// If true, fields without the tag defined via TagName are ignored.
	// They are not written to the output file,
	// and will also not write a header.
	// Defaults to "false".
	IgnoreFieldsWithoutTag bool
}

type WriteConfigurator interface{ WriteConfigure(wc *WriteConfig) }

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