README
¶
Коллекция файлов.
Пакет предоставляет реализацию интерфейса github.com/D3rus/go-library/file/Collection
которая находится в файле files.go.
Так же пакет предоставляет несколько оберток:
- TarGZ - если файлы находятся в архивах
tar.gz, при вызове методаNextархив будет распакован, метод конструкторNewTarGZ(collection file.Collection, directory string), directory - путь до директории, в которую будут распаковываться архивы; - ZIP - если файлы находятся в архивах
zip, при вызове методаNextархив будет распакован, метод конструкторNewZIP(collection file.Collection, directory string), directory - путь до директории, в которую будут распаковываться архивы; - Context - отслеживает закрытие контекста, если контекст закрыт, при вызове метода
Nextвернет ошибкуio.EOF, вне зависимости от кол. оставшихся файлов, метод конструкторNewContext(collection file.Collection, ctx context.Context).
Обертки реализованы для использования их с интерфейсом
github.com/D3rus/go-library/file/Collection, что позволяет использовать их отдельно.
Пакет предоставляет метод New(directory string, namer file.Namer, options ...file.CollectionOption) (file.Collection, error),
для легкого получения готового объекта коллекции файлов, directory - путь до директории в которой расположены файлы,
options - является опциональным аргументом, пакет предоставляет следующие методы опций:
- WithArchiveTarGZ - добавляет обертку TarGZ;
- WithArchiveZIP - добавляет обертку ZIP;
- WithArchive - добавляет обертку TarGZ либо ZIP, выбор обертки проходит автоматически в зависимости от ОС, для всех UNIX подобных систем будет выбран тип архивов TarGZ, для Windows ZIP;
- WithContext - добавляет обертку Context;
- WithCheckDirectory - проверяет директорию на существование и доступность, если директория не существует, создает её;
- WithFileCount - устанавливает в метрике кол. файлов, на момент создания коллекции.
Важно. Все опции будут примениться в той последовательности, в которой они были переданы.
Documentation
¶
Index ¶
- func New(directory string, namer file.Namer, options ...file.CollectionOption) (file.Collection, error)
- func WithArchive(directory string) file.CollectionOption
- func WithArchiveTarGZ(directory string) file.CollectionOption
- func WithArchiveZIP(directory string) file.CollectionOption
- func WithCheckDirectory(directoryPath string) file.CollectionOption
- func WithContext(ctx context.Context) file.CollectionOption
- func WithFileCount(counter prometheus.Gauge, directory string) file.CollectionOption
- type Context
- type Files
- type TarGZ
- type ZIP
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(directory string, namer file.Namer, options ...file.CollectionOption) (file.Collection, error)
func WithArchive ¶
func WithArchive(directory string) file.CollectionOption
func WithArchiveTarGZ ¶
func WithArchiveTarGZ(directory string) file.CollectionOption
func WithArchiveZIP ¶
func WithArchiveZIP(directory string) file.CollectionOption
func WithCheckDirectory ¶
func WithCheckDirectory(directoryPath string) file.CollectionOption
func WithContext ¶
func WithContext(ctx context.Context) file.CollectionOption
func WithFileCount ¶
func WithFileCount(counter prometheus.Gauge, directory string) file.CollectionOption
Types ¶
type Context ¶
type Context struct {
file.Collection
// contains filtered or unexported fields
}
func NewContext ¶
func NewContext(collection file.Collection, ctx context.Context) *Context
type TarGZ ¶
type TarGZ struct {
file.Collection
// contains filtered or unexported fields
}
Source Files