📝 Add docstrings to hotfix/analytic

Docstrings generation was requested by @wzxjohn.

* https://github.com/QuantumNous/new-api/pull/2133#issuecomment-3484993715

The following files were modified:

* `common/embed-file-system.go`
This commit is contained in:
coderabbitai[bot]
2025-11-04 09:56:24 +00:00
committed by GitHub
parent 6a761c2dba
commit 4e9cc4a36c

View File

@@ -4,6 +4,7 @@ import (
"embed" "embed"
"io/fs" "io/fs"
"net/http" "net/http"
"os"
"github.com/gin-contrib/static" "github.com/gin-contrib/static"
) )
@@ -14,7 +15,7 @@ type embedFileSystem struct {
http.FileSystem http.FileSystem
} }
func (e embedFileSystem) Exists(prefix string, path string) bool { func (e *embedFileSystem) Exists(prefix string, path string) bool {
_, err := e.Open(path) _, err := e.Open(path)
if err != nil { if err != nil {
return false return false
@@ -22,12 +23,22 @@ func (e embedFileSystem) Exists(prefix string, path string) bool {
return true return true
} }
func (e *embedFileSystem) Open(name string) (http.File, error) {
if name == "/" {
// This will make sure the index page goes to NoRouter handler,
// which will use the replaced index bytes with analytic codes.
return nil, os.ErrNotExist
}
return e.FileSystem.Open(name)
}
// requested subtree cannot be opened.
func EmbedFolder(fsEmbed embed.FS, targetPath string) static.ServeFileSystem { func EmbedFolder(fsEmbed embed.FS, targetPath string) static.ServeFileSystem {
efs, err := fs.Sub(fsEmbed, targetPath) efs, err := fs.Sub(fsEmbed, targetPath)
if err != nil { if err != nil {
panic(err) panic(err)
} }
return embedFileSystem{ return &embedFileSystem{
FileSystem: http.FS(efs), FileSystem: http.FS(efs),
} }
} }