README
¶
MesonTerminalEchoServer
Documentation
¶
Index ¶
- func AddHeader(c echo.Context, filePath string, ignoreHeaderMap map[string]struct{}) error
- func Copy(hs *HttpServer, dst io.Writer, src io.Reader) (written int64, err error)
- func CopyN(hs *HttpServer, dst io.Writer, src io.Reader, n int64) (written int64, err error)
- func FileWithPause(hs *HttpServer, c echo.Context, filePath string, header map[string][]string, ...) (err error)
- func ServeContent(hs *HttpServer, w http.ResponseWriter, req *http.Request, name string, ...)
- func ServeFile(hs *HttpServer, w http.ResponseWriter, r *http.Request, name string)
- type Dir
- type File
- type FileSystem
- type HttpServer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CopyN ¶
CopyN copies n bytes (or until an error) from src to dst. It returns the number of bytes copied and the earliest error encountered while copying. On return, written == n if and only if err == nil.
If dst implements the ReaderFrom interface, the copy is implemented using it.
func FileWithPause ¶
func ServeContent ¶
func ServeContent(hs *HttpServer, w http.ResponseWriter, req *http.Request, name string, modtime time.Time, content io.ReadSeeker)
ServeContent replies to the request using the content in the provided ReadSeeker. The main benefit of ServeContent over io.Copy is that it handles Range requests properly, sets the MIME type, and handles If-Match, If-Unmodified-Since, If-None-Match, If-Modified-Since, and If-Range requests.
If the response's Content-Type header is not set, ServeContent first tries to deduce the type from name's file extension and, if that fails, falls back to reading the first block of the content and passing it to DetectContentType. The name is otherwise unused; in particular it can be empty and is never sent in the response.
If modtime is not the zero time or Unix epoch, ServeContent includes it in a Last-Modified header in the response. If the request includes an If-Modified-Since header, ServeContent uses modtime to decide whether the content needs to be sent at all.
The content's Seek method must work: ServeContent uses a seek to the end of the content to determine its size.
If the caller has set w's ETag header formatted per RFC 7232, section 2.3, ServeContent uses it to handle requests using If-Match, If-None-Match, or If-Range.
Note that *os.File implements the io.ReadSeeker interface.
func ServeFile ¶
func ServeFile(hs *HttpServer, w http.ResponseWriter, r *http.Request, name string)
ServeFile replies to the http.Request with the contents of the named file or directory.
If the provided file or directory name is a relative path, it is interpreted relative to the current directory and may ascend to parent directories. If the provided name is constructed from user input, it should be sanitized before calling ServeFile.
As a precaution, ServeFile will reject http.Requests where r.URL.Path contains a ".." path element; this protects against callers who might unsafely use filepath.Join on r.URL.Path without sanitizing it and then use that filepath.Join result as the name argument.
As another special case, ServeFile redirects any http.Request where r.URL.Path ends in "/index.html" to the same path, without the final "index.html". To avoid such redirects either modify the path or use ServeContent.
Outside of those two special cases, ServeFile does not use r.URL.Path for selecting the file or directory to serve; only the file or directory provided in the name argument is used.
Types ¶
type Dir ¶
type Dir string
A Dir implements FileSystem using the native file system restricted to a specific directory tree.
While the FileSystem.Open method takes '/'-separated paths, a Dir's string value is a filename on the native file system, not a URL, so it is separated by filepath.Separator, which isn't necessarily '/'.
Note that Dir could expose sensitive files and directories. Dir will follow symlinks pointing out of the directory tree, which can be especially dangerous if serving from a directory in which users are able to create arbitrary symlinks. Dir will also allow access to files and directories starting with a period, which could expose sensitive directories like .git or sensitive files like .htpasswd. To exclude files with a leading period, remove the files/directories from the server or create a custom FileSystem implementation.
An empty Dir is treated as ".".
type File ¶
type File interface {
io.Closer
io.Reader
io.Seeker
Readdir(count int) ([]os.FileInfo, error)
Stat() (os.FileInfo, error)
}
A File is returned by a FileSystem's Open method and can be served by the FileServer implementation.
The methods should behave the same as those on an *os.File.
type FileSystem ¶
A FileSystem implements access to a collection of named files. The elements in a file path are separated by slash ('/', U+002F) characters, regardless of host operating system convention.
type HttpServer ¶
type HttpServer struct {
*echo.Echo
PauseMoment int64
}
func New ¶
func New() (hs *HttpServer)
func (*HttpServer) CloseServer ¶
func (hs *HttpServer) CloseServer()
func (*HttpServer) GetPauseMoment ¶
func (hs *HttpServer) GetPauseMoment() int64
func (*HttpServer) SetPauseSeconds ¶
func (hs *HttpServer) SetPauseSeconds(secs int64)
func (*HttpServer) UseJsoniter ¶
func (hs *HttpServer) UseJsoniter()
func (*HttpServer) WaitForServerStart ¶
func (hs *HttpServer) WaitForServerStart(isTLS bool) error
Source Files
Directories