options

Feb 10, 2025

Changes in this version

type Data

+ DisabledColors bool

Jan 6, 2025

Changes in this version

+ const OptEndSign

+ const OptNameValueSep

+ const OptSep

+ const OptStartSign

+ type EmptyOptionNameError struct

+ func NewEmptyOptionNameError(str string) *EmptyOptionNameError

+ func (err EmptyOptionNameError) Error() string

+ type InvalidOptionError struct

+ func NewInvalidOptionError(str string) *InvalidOptionError

+ func (err InvalidOptionError) Error() string

+ type InvalidOptionNameError struct

+ func NewInvalidOptionNameError(name string, opts Options) *InvalidOptionNameError

+ func (err InvalidOptionNameError) Error() string

+ type InvalidOptionValueError struct

+ func NewInvalidOptionValueError(opt Option, val string, err error) *InvalidOptionValueError

+ func (err InvalidOptionValueError) Error() string

+ func (err InvalidOptionValueError) Unwrap() error

type Options

+ func (opts Options) Configure(str string) (string, error)

Nov 18, 2024

Changes in this version

+ const AlignOptionName

+ const CaseOptionName

+ const ColorOptionName

+ const ContentOptionName

+ const DateOnly

+ const DateTime

+ const Day

+ const DayText

+ const DayZero

+ const EscapeOptionName

+ const Hour12

+ const Hour12Zero

+ const Hour24Zero

+ const LevelFormatOptionName

+ const MicroSec

+ const MilliSec

+ const MinZero

+ const MonthNum

+ const MonthNumZero

+ const MonthText

+ const PMLower

+ const PMUpper

+ const PathFormatOptionName

+ const PrefixOptionName

+ const RFC3339

+ const RFC3339Nano

+ const SecZero

+ const SuffixOptionName

+ const TZNum

+ const TZNumWithColon

+ const TZText

+ const TimeFormatOptionName

+ const TimeOnly

+ const WidthOptionName

+ const Year

+ const YearFull

+ type AlignOption struct

+ func (option *AlignOption) Format(_ *Data, str string) (string, error)

+ type AlignValue byte

+ const CenterAlign

+ const LeftAlign

+ const NoneAlign

+ const RightAlign

+ type CaseOption struct

+ func (option *CaseOption) Format(_ *Data, str string) (string, error)

+ type CaseValue byte

+ const CapitalizeCase

+ const LowerCase

+ const NoneCase

+ const UpperCase

+ type ColorFunc func(string) string

+ type ColorList struct

+ func NewColorList(list map[ColorValue]string) ColorList

+ func (val *ColorList) Parse(str string) error

+ func (val *ColorList) Set(v ColorValue) *ColorList

+ type ColorOption struct

+ func (color *ColorOption) Format(data *Data, str string) (string, error)

+ type ColorScheme map[ColorValue]ColorStyle

+ func (scheme ColorScheme) Compile() compiledColorScheme

+ type ColorStyle string

+ func (val ColorStyle) ColorFunc() ColorFunc

+ type ColorValue int

+ const BlackColor

+ const BlueColor

+ const CyanColor

+ const DisableColor

+ const GradientColor

+ const GreenColor

+ const LightBlackColor

+ const LightBlueColor

+ const LightCyanColor

+ const LightGreenColor

+ const LightMagentaColor

+ const LightRedColor

+ const LightWhiteColor

+ const LightYellowColor

+ const MagentaColor

+ const NoneColor

+ const PresetColor

+ const RedColor

+ const WhiteColor

+ const YellowColor

+ type CommonOption struct

+ func NewCommonOption[T comparable](name string, value OptionValue[T]) *CommonOption[T]

+ func (option *CommonOption[T]) Format(_ *Data, str string) (string, error)

+ func (option *CommonOption[T]) Name() string

+ func (option *CommonOption[T]) ParseValue(str string) error

+ func (option *CommonOption[T]) String() string

+ type ContentOption struct

+ func (option *ContentOption) Format(_ *Data, str string) (string, error)

+ type Data struct

+ BaseDir string

+ DisableColors bool

+ PresetColorFn func() ColorValue

+ RelativePather *RelativePather

+ type EscapeOption struct

+ func (option *EscapeOption) Format(_ *Data, str string) (string, error)

+ type EscapeValue byte

+ const JSONEscape

+ const NoneEscape

+ type IntValue int

+ func NewIntValue(val int) *IntValue

+ func (val *IntValue) Get() int

+ func (val *IntValue) Parse(str string) error

+ type LevelFormatOption struct

+ func (format *LevelFormatOption) Format(data *Data, _ string) (string, error)

+ type LevelFormatValue byte

+ const LevelFormatFull

+ const LevelFormatShort

+ const LevelFormatTiny

+ type MapValue struct

+ func NewMapValue[T comparable](list map[T]string) MapValue[T]

+ func (val *MapValue[T]) Filter(vals ...T) MapValue[T]

+ func (val *MapValue[T]) Get() T

+ func (val *MapValue[T]) Parse(str string) error

+ func (val MapValue[T]) Set(v T) *MapValue[T]

+ type Option interface

+ Format func(data *Data, str string) (string, error)

+ Name func() string

+ ParseValue func(str string) error

+ func Align(value AlignValue) Option

+ func Case(value CaseValue) Option

+ func Color(val ColorValue) Option

+ func Content(val string) Option

+ func Escape(val EscapeValue) Option

+ func LevelFormat(val LevelFormatValue) Option

+ func PathFormat(val PathFormatValue, allowed ...PathFormatValue) Option

+ func Prefix(val string) Option

+ func Suffix(val string) Option

+ func TimeFormat(val string) Option

+ func Width(val int) Option

+ type OptionValue interface

+ Get func() T

+ Parse func(str string) error

+ type Options []Option

+ func (opts Options) Format(data *Data, str string) (string, error)

+ func (opts Options) Get(name string) Option

+ func (opts Options) Merge(withOpts ...Option) Options

+ func (opts Options) Names() []string

+ type PathFormatOption struct

+ func (option *PathFormatOption) Format(data *Data, str string) (string, error)

+ type PathFormatValue byte

+ const DirectoryPath

+ const FilenamePath

+ const NonePath

+ const RelativePath

+ const ShortPath

+ const ShortRelativePath

+ type PrefixOption struct

+ func (option *PrefixOption) Format(_ *Data, str string) (string, error)

+ type RelativePather struct

+ func NewRelativePather(baseDir string) (*RelativePather, error)

+ func (hook *RelativePather) ReplaceAbsPaths(str string) string

+ type StringValue string

+ func NewStringValue(val string) *StringValue

+ func (val *StringValue) Get() string

+ func (val *StringValue) Parse(str string) error

+ type SuffixOption struct

+ func (option *SuffixOption) Format(_ *Data, str string) (string, error)

+ type TimeFormatOption struct

+ func (option *TimeFormatOption) Format(data *Data, _ string) (string, error)

+ type TimeFormatValue struct

+ func NewTimeFormatValue(list map[string]string) *TimeFormatValue

+ func (val *TimeFormatValue) Parse(str string) error

+ func (val TimeFormatValue) Set(v string) *TimeFormatValue

+ func (val TimeFormatValue) SortedKeys() []string

+ func (val TimeFormatValue) Value(str string) string

+ type WidthOption struct

+ func (option *WidthOption) Format(_ *Data, str string) (string, error)