zipfs

README

zipfs

Go lang zip http.FileSystem

Installation

$ go get github.com/dolfly/httpfs/zipfs

Usage

import "github.com/dolfly/httpfs/zipfs"

Examples

New

package main

import (
	"github.com/dolfly/httpfs/zipfs"
	"log"
	"net/http"
	"os"
)

func main() {
	b, err := os.ReadFile("public.zip")
	if err != nil {
		log.Fatal(err)
	}

	fs, err := zipfs.New(b, &zipfs.Options{Prefix: "public"})
	if err != nil {
		log.Fatal(err)
	}

	http.Handle("/", http.FileServer(fs))
	http.ListenAndServe(":8080", nil)
}

Simple zip webserver(use New)

Open

package main

import (
	"github.com/dolfly/httpfs/zipfs"
	"log"
	"net/http"
)

func main() {
	fs, err := zipfs.Open("public.zip", &zipfs.Options{Prefix: "public"})
	if err != nil {
		log.Fatal(err)
	}
	defer fs.Close()

	http.Handle("/", http.FileServer(fs))
	http.ListenAndServe(":8080", nil)
}

Simple zip webserver(use Open)

Author

gnue

License

MIT

Documentation

Overview

Go lang zip http.FileSystem

Index

• Variables
• func NewIgnore(pattern []string) (*regexp.Regexp, error)
• type Dinfo
  • func (d *Dinfo) FileInfo() os.FileInfo
  • func (d *Dinfo) Open() (http.File, error)
• type Dir
  • func (d *Dir) Close() error
  • func (d *Dir) Read(p []byte) (int, error)
  • func (d *Dir) Readdir(count int) (finfos []os.FileInfo, err error)
  • func (d *Dir) Seek(offset int64, whence int) (int64, error)
  • func (d *Dir) Stat() (os.FileInfo, error)
• type DirInfo
  • func (f *DirInfo) IsDir() bool
  • func (f *DirInfo) ModTime() time.Time
  • func (f *DirInfo) Mode() os.FileMode
  • func (f *DirInfo) Name() string
  • func (f *DirInfo) Size() int64
  • func (f *DirInfo) Sys() interface{}
• type File
  • func (f *File) Close() error
  • func (f *File) Read(p []byte) (int, error)
  • func (f *File) Readdir(count int) (finfos []os.FileInfo, err error)
  • func (f *File) Seek(offset int64, whence int) (int64, error)
  • func (f *File) Stat() (os.FileInfo, error)
• type FileSystem
  • func New(data []byte, opts *Options) (*FileSystem, error)
  • func (fs *FileSystem) Open(name string) (file http.File, err error)
• type FileSystemCloser
  • func Open(name string, opts *Options) (*FileSystemCloser, error)
  • func (z *FileSystemCloser) Close() error
• type Finfo
• type Options
• type ReadCloser
• type Reader
• type ZipFile
  • func (z *ZipFile) FileInfo() os.FileInfo
  • func (z *ZipFile) Open() (http.File, error)

Examples

• New
• Open

Variables

var OSX_Ignore = []string{"__MACOSX", ".DS_Store"}

Functions

func NewIgnore

func NewIgnore(pattern []string) (*regexp.Regexp, error)

Types

type Dinfo

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

func (*Dinfo) FileInfo

func (d *Dinfo) FileInfo() os.FileInfo

func (*Dinfo) Open

func (d *Dinfo) Open() (http.File, error)

type Dir

type Dir struct {
	*Dinfo
	// contains filtered or unexported fields
}

func (*Dir) Close

func (d *Dir) Close() error

func (*Dir) Read

func (d *Dir) Read(p []byte) (int, error)

func (*Dir) Readdir

func (d *Dir) Readdir(count int) (finfos []os.FileInfo, err error)

func (*Dir) Seek

func (d *Dir) Seek(offset int64, whence int) (int64, error)

func (*Dir) Stat

func (d *Dir) Stat() (os.FileInfo, error)

type DirInfo

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

func (*DirInfo) IsDir

func (f *DirInfo) IsDir() bool

func (*DirInfo) ModTime

func (f *DirInfo) ModTime() time.Time

func (*DirInfo) Mode

func (f *DirInfo) Mode() os.FileMode

func (*DirInfo) Name

func (f *DirInfo) Name() string

func (*DirInfo) Size

func (f *DirInfo) Size() int64

func (*DirInfo) Sys

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

type File

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

func (*File) Close

func (f *File) Close() error

func (*File) Read

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

func (*File) Readdir

func (f *File) Readdir(count int) (finfos []os.FileInfo, err error)

func (*File) Seek

func (f *File) Seek(offset int64, whence int) (int64, error)

func (*File) Stat

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

type FileSystem

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

func New

func New(data []byte, opts *Options) (*FileSystem, error)

Example

Simple zip webserver(use New)

package main

import (
	"log"
	"net/http"
	"os"

	"github.com/dolfly/httpfs/zipfs"
)

func main() {
	b, err := os.ReadFile("public.zip")
	if err != nil {
		log.Fatal(err)
	}

	fs, err := zipfs.New(b, &zipfs.Options{Prefix: "public"})
	if err != nil {
		log.Fatal(err)
	}

	http.Handle("/", http.FileServer(fs))
	http.ListenAndServe(":8080", nil)
}

func (*FileSystem) Open

func (fs *FileSystem) Open(name string) (file http.File, err error)

type FileSystemCloser

type FileSystemCloser struct {
	FileSystem
	Filename string
	// contains filtered or unexported fields
}

func Open

func Open(name string, opts *Options) (*FileSystemCloser, error)

Example

Simple zip webserver(use Open)

package main

import (
	"log"
	"net/http"

	"github.com/dolfly/httpfs/zipfs"
)

func main() {
	fs, err := zipfs.Open("public.zip", &zipfs.Options{Prefix: "public"})
	if err != nil {
		log.Fatal(err)
	}
	defer fs.Close()

	http.Handle("/", http.FileServer(fs))
	http.ListenAndServe(":8080", nil)
}

func (*FileSystemCloser) Close

func (z *FileSystemCloser) Close() error

type Finfo

type Finfo interface {
	FileInfo() os.FileInfo
	Open() (http.File, error)
}

type Options

type Options struct {
	Prefix string
	Ignore []string
}

type ReadCloser

type ReadCloser interface {
	Reader
	io.Closer
}

ReadCloser

type Reader

type Reader interface {
	File() []*zip.File
	Comment() string
	RegisterDecompressor(method uint16, dcomp zip.Decompressor)
}

Reader

type ZipFile

type ZipFile struct {
	File *zip.File
}

func (*ZipFile) FileInfo

func (z *ZipFile) FileInfo() os.FileInfo

func (*ZipFile) Open

func (z *ZipFile) Open() (http.File, error)