zipfs

README

zipfs

This package implements a fs.FS for zip archives until https://github.com/golang/go/issues/43872 is solved.

Documentation

Overview

Package zipfs provides an io/fs implementation to access zip files.

Index

• type FS
  • func New(base fsio.ReadSeekerAt) (*FS, error)
  • func (fsys *FS) Open(name string) (fs.File, error)
• type File
  • func (f *File) Close() (err error)
  • func (f *File) Name() string
  • func (f *File) Read(p []byte) (n int, err error)
  • func (f *File) ReadDir(count int) ([]fs.DirEntry, error)
  • func (f *File) Stat() (fs.FileInfo, error)
  • func (f *File) Sys() interface{}

Types

type FS

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

FS implements a read-only file system for zip files.

func New

func New(base fsio.ReadSeekerAt) (*FS, error)

New creates a new zip FS.

func (*FS) Open

func (fsys *FS) Open(name string) (fs.File, error)

Open opens a file for reading.

type File

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

File describes files and directories in the zip file system.

func (*File) Close

func (f *File) Close() (err error)

Close closes the file freeing the resource. Other IO operations fail after closing.

func (*File) Name

func (f *File) Name() string

Name returns the name of the file.

func (*File) Read

func (f *File) Read(p []byte) (n int, err error)

Read reads bytes into the passed buffer.

func (*File) ReadDir

func (f *File) ReadDir(count int) ([]fs.DirEntry, error)

Readdirnames returns up to n child items of a directory.

func (*File) Stat

func (f *File) Stat() (fs.FileInfo, error)

Stat return an fs.FileInfo object that describes a file.

func (*File) Sys

func (f *File) Sys() interface{}

Sys returns underlying data source.