context

package

v0.0.0-...-d0e669d Latest Latest Go to latest Published: Feb 16, 2024 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/NekoWheel/NekoBox

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func APIEndpoint(ctx Context)
func Contexter() flamego.Handler
func Toggle(options *ToggleOptions) flamego.Handler
type Context
type EndpointType
- func (e EndpointType) IsAPI() bool
- func (e EndpointType) IsWeb() bool
type Flash
type FlashType
type ToggleOptions

Constants ¶

View Source

const (
	Info    = "info"
	Success = "success"
	Warning = "warning"
	Error   = "error"
)

Variables ¶

This section is empty.

Functions ¶

func APIEndpoint ¶

func APIEndpoint(ctx Context)

func Contexter ¶

func Contexter() flamego.Handler

Contexter initializes a classic context for a request.

func Toggle ¶

func Toggle(options *ToggleOptions) flamego.Handler

Types ¶

type Context ¶

type Context struct {
	flamego.Context

	Data     template.Data
	Session  session.Session
	Template template.Template

	User     *db.User
	IsLogged bool
}

Context represents context of a request.

func (*Context) HasError ¶

func (c *Context) HasError() bool

HasError returns true if error occurs in form validation.

func (*Context) JSON ¶

func (c *Context) JSON(data interface{}) error

func (*Context) JSONError ¶

func (c *Context) JSONError(errorCode int, message string) error

func (*Context) Refresh ¶

func (c *Context) Refresh()

func (*Context) ServerError ¶

func (c *Context) ServerError() error

func (*Context) SetError ¶

func (c *Context) SetError(err error, f ...interface{})

func (Context) SetErrorFlash ¶

func (c Context) SetErrorFlash(message string, tip ...string)

func (Context) SetInfoFlash ¶

func (c Context) SetInfoFlash(message string, tip ...string)

func (*Context) SetInternalError ¶

func (c *Context) SetInternalError(f ...interface{})

func (Context) SetInternalErrorFlash ¶

func (c Context) SetInternalErrorFlash()

func (Context) SetSuccessFlash ¶

func (c Context) SetSuccessFlash(message string, tip ...string)

func (*Context) SetTitle ¶

func (c *Context) SetTitle(title string)

func (Context) SetWarningFlash ¶

func (c Context) SetWarningFlash(message string, tip ...string)

func (*Context) Success ¶

func (c *Context) Success(templateName string)

Success renders HTML template with given name with 200 OK status code.

type EndpointType ¶

type EndpointType string

const (
	EndpointAPI EndpointType = "api"
	EndpointWeb EndpointType = "web"
)

func (EndpointType) IsAPI ¶

func (e EndpointType) IsAPI() bool

func (EndpointType) IsWeb ¶

func (e EndpointType) IsWeb() bool

type Flash ¶

type Flash struct {
	Type     FlashType
	Message  string
	FlashTip string
}

type FlashType ¶

type FlashType string

type ToggleOptions ¶

type ToggleOptions struct {
	UserSignInRequired  bool
	UserSignOutRequired bool
}

Source Files ¶

View all Source files

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