xun

package module

Go to main page

Versions in this module

v1

v1.3.2

Aug 25, 2026

Changes in this version

+ type BreadcrumbItem struct

+ Last bool

+ Name string

+ Path string

+ Title string

+ type ContentView struct

+ Body template.HTML

+ Date time.Time

+ Description string

+ Params map[string]any

+ Path string

+ Slug string

+ Title string

type Option

+ func WithContent(dirs ...string) Option

+ func WithContentRenderer(render func(content []byte, path string) (template.HTML, error)) Option

type ViewModel

+ Breadcrumb []BreadcrumbItem

+ Content *ContentView

v1.2.2

Jul 10, 2026

v1.2.1

Jul 10, 2026

v1.2.0

Jul 8, 2026

Changes in this version

type App

+ func (app *App) Mux() *http.ServeMux

v1.1.6

Mar 31, 2026

v1.1.5

Aug 13, 2025

v1.1.4

May 5, 2025

Changes in this version

type App

+ AssetURLs map[string]string

type Option

+ func WithBuildAssetURL(match func(string) bool) Option

+ func WithTemplateFunc(name string, fn any) Option

+ func WithTemplateFuncMap(fm template.FuncMap) Option

v1.1.3

Feb 27, 2025

Changes in this version

+ func ComputeETag(r io.Reader) string

+ func ComputeETagWith(r io.Reader, h hash.Hash) string

+ func WriteIfNoneMatch(w http.ResponseWriter, r *http.Request) bool

+ type Decoder interface

+ Decode func(obj interface{}) error

+ type Encoder interface

+ Encode func(val interface{}) error

+ type JsonEncoding interface

+ NewDecoder func(reader io.Reader) Decoder

+ NewEncoder func(writer io.Writer) Encoder

+ var Json JsonEncoding = &stdJsonEncoding{}

v1.1.2

Feb 17, 2025

Changes in this version

type Context

+ App *App

+ TempData TempData

+ type TempData map[string]any

type TextTemplate

+ func NewTextTemplate(t *template.Template) *TextTemplate

type TextViewer

+ func NewTextViewer(t *TextTemplate) *TextViewer

+ type ViewModel struct

+ Data any

+ TempData map[string]any

v1.1.1

Feb 13, 2025

Changes in this version

type ResponseWriter

+ func NewResponseWriter(rw http.ResponseWriter) ResponseWriter

+ BodyBytesSent func() int

+ StatusCode func() int

v1.1.0

Feb 9, 2025

Changes in this version

+ var ErrViewNotFound = errors.New("xun: view_not_found")

type Context

+ Response http.ResponseWriter

v1.0.7

Jan 25, 2025

Changes in this version

+ var StringViewerMime = &MimeType

type FileViewer

+ func NewFileViewer(fsys fs.FS, path string, isEmbed bool) *FileViewer

+ type StringViewer struct

+ func (*StringViewer) MimeType() *MimeType

+ func (*StringViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

v1.0.6

Jan 19, 2025

Changes in this version

+ var XmlViewerMime = &MimeType

+ type MimeType struct

+ SubType string

+ Type string

+ func NewMimeType(t string) MimeType

+ func (m *MimeType) Match(accept MimeType) bool

+ func (m *MimeType) String() string

type Option

+ func WithHandlerViewers(v ...Viewer) Option

+ type XmlViewer struct

+ func (*XmlViewer) MimeType() *MimeType

+ func (*XmlViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

v1.0.5

Jan 15, 2025

Changes in this version

+ func GetMimeType(file string, buf []byte) (string, string)

+ type TextTemplate struct

+ func (t *TextTemplate) Execute(wr io.Writer, data any) error

+ func (t *TextTemplate) Load(fsys fs.FS) error

+ func (t *TextTemplate) Reload(fsys fs.FS) error

+ type TextViewEngine struct

+ func (ve *TextViewEngine) FileChanged(fsys fs.FS, _ *App, event fsnotify.Event) error

+ func (ve *TextViewEngine) Load(fsys fs.FS, app *App) error

+ type TextViewer struct

+ func (v *TextViewer) MimeType() string

+ func (v *TextViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

v1.0.4

Jan 5, 2025

Changes in this version

+ type Compressor interface

+ AcceptEncoding func() string

+ New func(rw http.ResponseWriter) ResponseWriter

+ type DeflateCompressor struct

+ func (c *DeflateCompressor) AcceptEncoding() string

+ func (c *DeflateCompressor) New(rw http.ResponseWriter) ResponseWriter

+ type GzipCompressor struct

+ func (c *GzipCompressor) AcceptEncoding() string

+ func (c *GzipCompressor) New(rw http.ResponseWriter) ResponseWriter

type Option

+ func WithCompressor(c ...Compressor) Option

+ type ResponseWriter interface

+ Close func()

v1.0.3

Jan 1, 2025

v1.0.2

Jan 1, 2025

Changes in this version

+ const NavigationAccess

+ const NavigationIcon

+ const NavigationName

+ var ErrCancelled = errors.New("xun: request_cancelled")

+ var FuncMap template.FuncMap = make(template.FuncMap)

+ type App struct

+ func New(opts ...Option) *App

+ func (app *App) Close()

+ func (app *App) Delete(pattern string, hf HandleFunc, opts ...RoutingOption)

+ func (app *App) Get(pattern string, hf HandleFunc, opts ...RoutingOption)

+ func (app *App) Group(prefix string) Router

+ func (app *App) HandleFile(name string, v *FileViewer)

+ func (app *App) HandleFunc(pattern string, hf HandleFunc, opts ...RoutingOption)

+ func (app *App) HandlePage(pattern string, viewName string, v Viewer)

+ func (app *App) Next(hf HandleFunc) HandleFunc

+ func (app *App) Post(pattern string, hf HandleFunc, opts ...RoutingOption)

+ func (app *App) Put(pattern string, hf HandleFunc, opts ...RoutingOption)

+ func (app *App) Start()

+ func (app *App) Use(middleware ...Middleware)

+ type BufferPool struct

+ var BufPool *BufferPool

+ func NewBufferPool(size int) (bp *BufferPool)

+ func (bp *BufferPool) Get() (b *bytes.Buffer)

+ func (bp *BufferPool) Put(b *bytes.Buffer)

+ type Context struct

+ Routing Routing

+ func (c *Context) Accept() (types []string)

+ func (c *Context) AcceptLanguage() (languages []string)

+ func (c *Context) Get(key string) any

+ func (c *Context) Redirect(url string, statusCode ...int)

+ func (c *Context) Request() *http.Request

+ func (c *Context) RequestReferer() *url.URL

+ func (c *Context) Set(key string, value any)

+ func (c *Context) View(items ...any) error

+ func (c *Context) WriteHeader(key string, value string)

+ func (c *Context) WriteStatus(code int)

+ func (c *Context) Writer() http.ResponseWriter

+ type FileViewer struct

+ func (*FileViewer) MimeType() string

+ func (v *FileViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

+ type HandleFunc func(c *Context) error

+ type Handler struct

+ Host string

+ Method string

+ Pattern string

+ Viewers []Viewer

+ type HtmlTemplate struct

+ func NewHtmlTemplate(name, path string) *HtmlTemplate

+ func (t *HtmlTemplate) Execute(wr io.Writer, data any) error

+ func (t *HtmlTemplate) Load(fsys fs.FS, templates map[string]*HtmlTemplate) error

+ func (t *HtmlTemplate) Reload(fsys fs.FS, templates map[string]*HtmlTemplate) error

+ type HtmlViewEngine struct

+ func (ve *HtmlViewEngine) FileChanged(fsys fs.FS, app *App, event fsnotify.Event) error

+ func (ve *HtmlViewEngine) Load(fsys fs.FS, app *App) error

+ type HtmlViewer struct

+ func (*HtmlViewer) MimeType() string

+ func (v *HtmlViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

+ type Interceptor interface

+ Redirect func(c *Context, url string, statusCode ...int) bool

+ RequestReferer func(c *Context) string

+ type JsonViewer struct

+ func (*JsonViewer) MimeType() string

+ func (j *JsonViewer) Render(w http.ResponseWriter, r *http.Request, data any) error

+ type Middleware func(next HandleFunc) HandleFunc

+ type Option func(*App)

+ func WithFsys(fsys fs.FS) Option

+ func WithInterceptor(i Interceptor) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithMux(mux *http.ServeMux) Option

+ func WithViewEngines(ve ...ViewEngine) Option

+ func WithViewer(v Viewer) Option

+ func WithWatch() Option

+ type Router interface

+ Delete func(pattern string, h HandleFunc, opts ...RoutingOption)

+ Get func(pattern string, h HandleFunc, opts ...RoutingOption)

+ HandleFunc func(pattern string, h HandleFunc, opts ...RoutingOption)

+ Post func(pattern string, h HandleFunc, opts ...RoutingOption)

+ Put func(pattern string, h HandleFunc, opts ...RoutingOption)

+ Use func(middlewares ...Middleware)

+ type Routing struct

+ Handle HandleFunc

+ Options *RoutingOptions

+ Pattern string

+ Viewers map[string]Viewer

+ func (r *Routing) Next(ctx *Context) error

+ type RoutingOption func(*RoutingOptions)

+ func WithMetadata(key string, value any) RoutingOption

+ func WithNavigation(name, icon, access string) RoutingOption

+ type RoutingOptions struct

+ func (ro *RoutingOptions) Get(name string) any

+ func (ro *RoutingOptions) GetInt(name string) int

+ func (ro *RoutingOptions) GetString(name string) string

+ type StaticViewEngine struct

+ func (ve *StaticViewEngine) FileChanged(fsys fs.FS, app *App, event fsnotify.Event) error

+ func (ve *StaticViewEngine) Load(fsys fs.FS, app *App) error

+ type TEntity struct

+ Data T

+ Errors map[string]string

+ func BindForm[T any](req *http.Request) (*TEntity[T], error)

+ func BindJson[T any](req *http.Request) (*TEntity[T], error)

+ func BindQuery[T any](req *http.Request) (*TEntity[T], error)

+ func (t *TEntity[T]) Validate(languages ...string) bool

+ type Validator struct

+ Translator ut.Translator

+ func AddValidator(trans ut.Translator, ...) *Validator

+ type ViewEngine interface

+ FileChanged func(fsys fs.FS, app *App, event fsnotify.Event) error

+ Load func(fsys fs.FS, app *App) error

+ type Viewer interface

+ MimeType func() string

+ Render func(w http.ResponseWriter, r *http.Request, data any) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL