rotatefile

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• type EmptyRotateFilerOption
• type RotateFiler
  • func NewRotateFiler(filedir string, options ...RotateFilerOption) (*RotateFiler, error)
  • func (o *RotateFiler) ApplyOptions(options ...RotateFilerOption) *RotateFiler
  • func (f *RotateFiler) Write(p []byte) (file *os.File, n int, err error)
• type RotateFilerOption
  • func WithFileTimeLayout(fileTimeLayout string) RotateFilerOption
  • func WithMaxAge(maxAge time.Duration) RotateFilerOption
  • func WithMaxCount(maxCount int64) RotateFilerOption
  • func WithPrefixName(prefixName string) RotateFilerOption
  • func WithRotateInterval(rotateInterval time.Duration) RotateFilerOption
  • func WithRotateSize(rotateSize int64) RotateFilerOption
  • func WithSuffixName(subfixName string) RotateFilerOption
• type RotateFilerOptionFunc

Types

type EmptyRotateFilerOption

type EmptyRotateFilerOption struct{}

EmptyRotateFilerOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type RotateFiler

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

func NewRotateFiler

func NewRotateFiler(filedir string, options ...RotateFilerOption) (*RotateFiler, error)

func (*RotateFiler) ApplyOptions

func (o *RotateFiler) ApplyOptions(options ...RotateFilerOption) *RotateFiler

func (*RotateFiler) Write

func (f *RotateFiler) Write(p []byte) (file *os.File, n int, err error)

type RotateFilerOption

type RotateFilerOption interface {
	// contains filtered or unexported methods
}

A RotateFilerOption sets options.

func WithFileTimeLayout

func WithFileTimeLayout(fileTimeLayout string) RotateFilerOption

func WithMaxAge

func WithMaxAge(maxAge time.Duration) RotateFilerOption

func WithMaxCount

func WithMaxCount(maxCount int64) RotateFilerOption

func WithPrefixName

func WithPrefixName(prefixName string) RotateFilerOption

func WithRotateInterval

func WithRotateInterval(rotateInterval time.Duration) RotateFilerOption

func WithRotateSize

func WithRotateSize(rotateSize int64) RotateFilerOption

func WithSuffixName

func WithSuffixName(subfixName string) RotateFilerOption

type RotateFilerOptionFunc

type RotateFilerOptionFunc func(*RotateFiler)

RotateFilerOptionFunc wraps a function that modifies Client into an implementation of the RotateFilerOption interface.