fastapi

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2020 License: MIT Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ContentType = struct {
	Text string
	JSON string
	Form string
}{
	Text: "text/plain",
	JSON: "application/json",
	Form: "application/x-www-form-urlencoded",
}

Functions

func SetLang 

func SetLang(lang Lang)

func SetMode 

func SetMode(mode Runmode)

func Throw 

func Throw(err error)

func ToInt 

func ToInt(s string) int64

Types

type AccessMap 

type AccessMap struct {
	*sync.RWMutex
	// contains filtered or unexported fields
}

func (*AccessMap) Add 

func (a *AccessMap) Add(p string)

func (*AccessMap) Get 

func (a *AccessMap) Get(p string) int64

func (*AccessMap) Sub 

func (a *AccessMap) Sub(p string)

type Any 

type Any map[string]interface{}

func (Any) Get 

func (this Any) Get(k string) (v interface{}, exist bool)

func (Any) GetBool 

func (this Any) GetBool(key string) (bool, bool)

func (Any) GetFloat64 

func (this Any) GetFloat64(key string) (float64, bool)

func (Any) GetInt64 

func (this Any) GetInt64(key string) (int64, bool)

func (Any) GetString 

func (this Any) GetString(key string) (string, bool)

func (Any) GetUint8 

func (this Any) GetUint8(key string) (uint8, bool)

func (Any) Set 

func (this Any) Set(k string, v interface{})

type Code 

type Code uint32

A Code is an unsigned 32-bit error code as defined in the gRPC spec. 

const (
	// OK is returned on success.
	OK Code = 0

	// Canceled indicates the operation was canceled (typically by the caller).
	Canceled Code = 1

	// Unknown error. An example of where this error may be returned is
	// if a Status value received from another address space belongs to
	// an error-space that is not known in this address space. Also
	// errors raised by APIs that do not return enough error information
	// may be converted to this error.
	Unknown Code = 2

	// InvalidArgument indicates client specified an invalid argument.
	// Note that this differs from FailedPrecondition. It indicates arguments
	// that are problematic regardless of the state of the system
	// (e.g., a malformed file name).
	InvalidArgument Code = 3

	// DeadlineExceeded means operation expired before completion.
	// For operations that change the state of the system, this error may be
	// returned even if the operation has completed successfully. For
	// example, a successful response from a server could have been delayed
	// long enough for the deadline to expire.
	DeadlineExceeded Code = 4

	// NotFound means some requested entity (e.g., file or directory) was
	// not found.
	NotFound Code = 5

	// AlreadyExists means an attempt to create an entity failed because one
	// already exists.
	AlreadyExists Code = 6

	// PermissionDenied indicates the caller does not have permission to
	// execute the specified operation. It must not be used for rejections
	// caused by exhausting some resource (use ResourceExhausted
	// instead for those errors). It must not be
	// used if the caller cannot be identified (use Unauthenticated
	// instead for those errors).
	PermissionDenied Code = 7

	// ResourceExhausted indicates some resource has been exhausted, perhaps
	// a per-user quota, or perhaps the entire file system is out of space.
	ResourceExhausted Code = 8

	// FailedPrecondition indicates operation was rejected because the
	// system is not in a state required for the operation's execution.
	// For example, directory to be deleted may be non-empty, an rmdir
	// operation is applied to a non-directory, etc.
	//
	// A litmus test that may help a service implementor in deciding
	// between FailedPrecondition, Aborted, and Unavailable:
	//  (a) Use Unavailable if the client can retry just the failing call.
	//  (b) Use Aborted if the client should retry at a higher-level
	//      (e.g., restarting a read-modify-write sequence).
	//  (c) Use FailedPrecondition if the client should not retry until
	//      the system state has been explicitly fixed. E.g., if an "rmdir"
	//      fails because the directory is non-empty, FailedPrecondition
	//      should be returned since the client should not retry unless
	//      they have first fixed up the directory by deleting files from it.
	//  (d) Use FailedPrecondition if the client performs conditional
	//      REST Get/Update/Delete on a resource and the resource on the
	//      server does not match the condition. E.g., conflicting
	//      read-modify-write on the same resource.
	FailedPrecondition Code = 9

	// Aborted indicates the operation was aborted, typically due to a
	// concurrency issue like sequencer check failures, transaction aborts,
	// etc.
	//
	// See litmus test above for deciding between FailedPrecondition,
	// Aborted, and Unavailable.
	Aborted Code = 10

	// OutOfRange means operation was attempted past the valid range.
	// E.g., seeking or reading past end of file.
	//
	// Unlike InvalidArgument, this error indicates a problem that may
	// be fixed if the system state changes. For example, a 32-bit file
	// system will generate InvalidArgument if asked to read at an
	// offset that is not in the range [0,2^32-1], but it will generate
	// OutOfRange if asked to read from an offset past the current
	// file size.
	//
	// There is a fair bit of overlap between FailedPrecondition and
	// OutOfRange. We recommend using OutOfRange (the more specific
	// error) when it applies so that callers who are iterating through
	// a space can easily look for an OutOfRange error to detect when
	// they are done.
	OutOfRange Code = 11

	// Unimplemented indicates operation is not implemented or not
	// supported/enabled in this service.
	Unimplemented Code = 12

	// Internal errors. Means some invariants expected by underlying
	// system has been broken. If you see one of these errors,
	// something is very broken.
	Internal Code = 13

	// Unavailable indicates the service is currently unavailable.
	// This is a most likely a transient condition and may be corrected
	// by retrying with a backoff.
	//
	// See litmus test above for deciding between FailedPrecondition,
	// Aborted, and Unavailable.
	Unavailable Code = 14

	// DataLoss indicates unrecoverable data loss or corruption.
	DataLoss Code = 15

	// Unauthenticated indicates the request does not have valid
	// authentication credentials for the operation.
	Unauthenticated Code = 16
)

func (*Code) UnmarshalJSON 

func (c *Code) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals b into the Code.

type Context 

type Context struct {
	Request     *http.Request
	Response    http.ResponseWriter
	Storage     Any
	ContentType string
	// contains filtered or unexported fields
}

func (*Context) Abort 

func (c *Context) Abort()

func (*Context) Bind 

func (c *Context) Bind(v interface{}) error

func (*Context) ClientIP 

func (c *Context) ClientIP() string

func (*Context) GetBody 

func (c *Context) GetBody() []byte

func (*Context) JSON 

func (c *Context) JSON(code int, v interface{}) error

func (*Context) Next 

func (c *Context) Next()

func (*Context) Write 

func (c *Context) Write(code int, body []byte) error

type CorsOption 

type CorsOption struct {
	AllowOrigin  string
	AllowMethods []string
	AllowHeaders []string
	MaxAge       int
}

type Error 

type Error struct {
	Code Code   `json:"code"`
	Msg  string `json:"msg"`
}

func NewError 

func NewError(code Code, msg string) *Error

func (*Error) Error 

func (this *Error) Error() string

func (*Error) Wrap 

func (this *Error) Wrap(msg string) *Error

type Group 

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

func (*Group) ANY 

func (g *Group) ANY(path string, handlers ...HandlerFunc)

func (*Group) GET 

func (g *Group) GET(path string, handlers ...HandlerFunc)

func (*Group) Group 

func (g *Group) Group(prefix string, handlers ...HandlerFunc) *Group

func (*Group) POST 

func (g *Group) POST(path string, handlers ...HandlerFunc)

type HandlerFunc 

type HandlerFunc func(ctx *Context)

func CORS 

func CORS(opt *CorsOption) HandlerFunc

func Limit 

func Limit(n int64) HandlerFunc

limit concurrent access speed

func Logger 

func Logger() HandlerFunc

type Lang 

type Lang uint8
const (
	Chinese Lang = iota
	English
)

type Runmode 

type Runmode uint8
const (
	DebugMode Runmode = iota
	ProductMode
)

func GetMode 

func GetMode() Runmode

func (Runmode) String 

func (r Runmode) String() string

type Server 

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

func New 

func New() *Server

func (*Server) ANY 

func (s *Server) ANY(path string, handles ...HandlerFunc)

func (*Server) GET 

func (s *Server) GET(path string, handles ...HandlerFunc)

func (*Server) Group 

func (s *Server) Group(prefix string, handlers ...HandlerFunc) *Group

func (*Server) POST 

func (s *Server) POST(path string, handles ...HandlerFunc)

func (*Server) Run 

func (s *Server) Run(addr string) error

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(res http.ResponseWriter, req *http.Request)

func (*Server) SetCatch 

func (s *Server) SetCatch(fn func(ctx *Context, err interface{}))

func (*Server) Use 

func (s *Server) Use(handles ...HandlerFunc)

global middleware

type TransError 

type TransError struct {
	Message string
	Field   string
}

func (*TransError) Error 

func (this *TransError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.