parser

package

v0.0.0-...-af559f1 Latest Latest Go to latest Published: Feb 11, 2023 License: MIT Imports: 11 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

Documentation ¶

Overview ¶

Package parser provides a pseudo parser that parses arikawa api files and maps them to Methods. It does not actually parse the api files, but rather utilizes the output generated by go's built-in parser, hence pseudo parser.

Index ¶

type File
type Method
type Param
type Parser
- func New(apiPath string) (*Parser, error)
- func (p *Parser) Parse() ([]File, error)
type Type

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type File ¶

type File struct {
	Name    string
	Methods []Method
}

type Method ¶

type Method struct {
	Name       string
	Params     []Param
	ReturnType *Type

	Multipart                          bool
	QueryParam, JSONParam, ReasonParam string

	HTTPMethod   string
	EndpointExpr ast.Expr
}

type Param ¶

type Param struct {
	Name string
	Type Type
}

type Parser ¶

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

func New ¶

func New(apiPath string) (*Parser, error)

func (*Parser) Parse ¶

func (p *Parser) Parse() ([]File, error)

type Type ¶

type Type struct {
	Slice    uint8
	Variadic bool
	ElemPtr  bool
	Package  string
	Name     string
}

Source Files ¶

View all Source files

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