web

Documentation

Index

• Constants
• Variables
• func Engine() *gin.Engine
• func JwtGenerate(id string, admin bool) (string, error)
• func OpenStaticFile(name string) (file http.File, err error)
• func Serve() error
• func ServeAutoCert() error
• func ServeHTTP() error
• func ServeTLS() error
• func ServeUnix() error
• func Shutdown() error
• func Startup() error
• func Static(fs http.FileSystem, path, prefix, index string)
• func StaticDir(dir string, path, prefix, index string)
• func StaticEmbedFS(fs embed.FS, path, prefix, index string)
• func StaticFS(fs fs.FS, path, prefix, index string)
• func StaticZip(zip string, path, prefix, index string)
• type Claims
  • func JwtVerify(str string) (*Claims, error)
• type Store
  • func (s *Store) Dir(dir string, base string)
  • func (s *Store) EmbedFS(fs embed.FS, base string)
  • func (s *Store) FS(fs fs.FS, base string)
  • func (s *Store) Open(name string) (file http.File, err error)
  • func (s *Store) Web(fs http.FileSystem, base string)
  • func (s *Store) Zip(zip string, base string)
• type ZipFS
  • func (z *ZipFS) Open(name string) (file http.File, err error)
• type ZipFile
  • func (f *ZipFile) Readdir(count int) ([]fs.FileInfo, error)
  • func (f *ZipFile) Seek(offset int64, whence int) (int64, error)

Constants

const MODULE = "web"

Variables

var JwtExpire = time.Hour * 24 * 30

var JwtKey = []byte("boat")

var Server *http.Server

Functions

func Engine

func Engine() *gin.Engine

func JwtGenerate

func JwtGenerate(id string, admin bool) (string, error)

func OpenStaticFile

func OpenStaticFile(name string) (file http.File, err error)

func Serve

func Serve() error

func ServeAutoCert

func ServeAutoCert() error

func ServeHTTP

func ServeHTTP() error

func ServeTLS

func ServeTLS() error

func ServeUnix

func ServeUnix() error

func Shutdown

func Shutdown() error

func Startup

func Startup() error

func Static

func Static(fs http.FileSystem, path, prefix, index string)

Static 静态目录 path url路径。 prefix 基本路径（主要用于zip文件）。 index 默认首页，index.html 代表SPA应用。

func StaticDir

func StaticDir(dir string, path, prefix, index string)

func StaticEmbedFS

func StaticEmbedFS(fs embed.FS, path, prefix, index string)

func StaticFS

func StaticFS(fs fs.FS, path, prefix, index string)

func StaticZip

func StaticZip(zip string, path, prefix, index string)

Types

type Claims

type Claims struct {
	jwt.RegisteredClaims
	Admin bool `json:"admin,omitempty"`
}

func JwtVerify

func JwtVerify(str string) (*Claims, error)

type Store

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

func (*Store) Dir

func (s *Store) Dir(dir string, base string)

func (*Store) EmbedFS

func (s *Store) EmbedFS(fs embed.FS, base string)

func (*Store) FS

func (s *Store) FS(fs fs.FS, base string)

func (*Store) Open

func (s *Store) Open(name string) (file http.File, err error)

func (*Store) Web

func (s *Store) Web(fs http.FileSystem, base string)

func (*Store) Zip

func (s *Store) Zip(zip string, base string)

type ZipFS

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

func (*ZipFS) Open

func (z *ZipFS) Open(name string) (file http.File, err error)

type ZipFile

type ZipFile struct {
	fs.File
}

func (*ZipFile) Readdir

func (f *ZipFile) Readdir(count int) ([]fs.FileInfo, error)

func (*ZipFile) Seek

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