rp

package
v0.0.0-...-21c442b Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type BeginFound 

type BeginFound struct {
	Location  OptURI
	SetCookie OptString
}

BeginFound is response for Begin operation.

func (*BeginFound) GetLocation 

func (s *BeginFound) GetLocation() OptURI

GetLocation returns the value of Location.

func (*BeginFound) GetSetCookie 

func (s *BeginFound) GetSetCookie() OptString

GetSetCookie returns the value of SetCookie.

func (*BeginFound) SetLocation 

func (s *BeginFound) SetLocation(val OptURI)

SetLocation sets the value of Location.

func (*BeginFound) SetSetCookie 

func (s *BeginFound) SetSetCookie(val OptString)

SetSetCookie sets the value of SetCookie.

type BeginInternalServerError 

type BeginInternalServerError struct{}

BeginInternalServerError is response for Begin operation.

type BeginParams 

type BeginParams struct {
	State       string
	CallbackURI url.URL
}

BeginParams is parameters of begin operation.

type BeginRes 

type BeginRes interface {
	// contains filtered or unexported methods
}

type CallbackFound 

type CallbackFound struct {
	Location  OptURI
	SetCookie OptString
}

CallbackFound is response for Callback operation.

func (*CallbackFound) GetLocation 

func (s *CallbackFound) GetLocation() OptURI

GetLocation returns the value of Location.

func (*CallbackFound) GetSetCookie 

func (s *CallbackFound) GetSetCookie() OptString

GetSetCookie returns the value of SetCookie.

func (*CallbackFound) SetLocation 

func (s *CallbackFound) SetLocation(val OptURI)

SetLocation sets the value of Location.

func (*CallbackFound) SetSetCookie 

func (s *CallbackFound) SetSetCookie(val OptString)

SetSetCookie sets the value of SetCookie.

type CallbackInternalServerError 

type CallbackInternalServerError struct{}

CallbackInternalServerError is response for Callback operation.

type CallbackParams 

type CallbackParams struct {
	QueryState  string
	Code        string
	CookieState string
}

CallbackParams is parameters of callback operation.

type CallbackRes 

type CallbackRes interface {
	// contains filtered or unexported methods
}

type Client 

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

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) Begin 

func (c *Client) Begin(ctx context.Context, params BeginParams) (BeginRes, error)

Begin invokes begin operation.

Begin.

GET /auth

func (*Client) Callback 

func (c *Client) Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)

Callback invokes callback operation.

Callback.

GET /callback

func (*Client) End 

func (c *Client) End(ctx context.Context, request *EndReq) (EndRes, error)

End invokes end operation.

End.

POST /auth

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type EndInternalServerError 

type EndInternalServerError struct{}

EndInternalServerError is response for End operation.

type EndOK 

type EndOK struct {
	AcceesToken  string `json:"accees_token"`
	RefreshToken string `json:"refresh_token"`
}

func (*EndOK) Decode 

func (s *EndOK) Decode(d *jx.Decoder) error

Decode decodes EndOK from json.

func (*EndOK) Encode 

func (s *EndOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EndOK) GetAcceesToken 

func (s *EndOK) GetAcceesToken() string

GetAcceesToken returns the value of AcceesToken.

func (*EndOK) GetRefreshToken 

func (s *EndOK) GetRefreshToken() string

GetRefreshToken returns the value of RefreshToken.

func (*EndOK) MarshalJSON 

func (s *EndOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EndOK) SetAcceesToken 

func (s *EndOK) SetAcceesToken(val string)

SetAcceesToken sets the value of AcceesToken.

func (*EndOK) SetRefreshToken 

func (s *EndOK) SetRefreshToken(val string)

SetRefreshToken sets the value of RefreshToken.

func (*EndOK) UnmarshalJSON 

func (s *EndOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EndReq 

type EndReq struct {
	State string `json:"state"`
}

func (*EndReq) Decode 

func (s *EndReq) Decode(d *jx.Decoder) error

Decode decodes EndReq from json.

func (*EndReq) Encode 

func (s *EndReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EndReq) GetState 

func (s *EndReq) GetState() string

GetState returns the value of State.

func (*EndReq) MarshalJSON 

func (s *EndReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EndReq) SetState 

func (s *EndReq) SetState(val string)

SetState sets the value of State.

func (*EndReq) UnmarshalJSON 

func (s *EndReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EndRes 

type EndRes interface {
	// contains filtered or unexported methods
}

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type Handler 

type Handler interface {
	// Begin implements begin operation.
	//
	// Begin.
	//
	// GET /auth
	Begin(ctx context.Context, params BeginParams) (BeginRes, error)
	// Callback implements callback operation.
	//
	// Callback.
	//
	// GET /callback
	Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)
	// End implements end operation.
	//
	// End.
	//
	// POST /auth
	End(ctx context.Context, req *EndReq) (EndRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker 

type Invoker interface {
	// Begin invokes begin operation.
	//
	// Begin.
	//
	// GET /auth
	Begin(ctx context.Context, params BeginParams) (BeginRes, error)
	// Callback invokes callback operation.
	//
	// Callback.
	//
	// GET /callback
	Callback(ctx context.Context, params CallbackParams) (CallbackRes, error)
	// End invokes end operation.
	//
	// End.
	//
	// POST /auth
	End(ctx context.Context, request *EndReq) (EndRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) Or 

func (o OptString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

type OptURI 

type OptURI struct {
	Value url.URL
	Set   bool
}

OptURI is optional url.URL.

func NewOptURI 

func NewOptURI(v url.URL) OptURI

NewOptURI returns new OptURI with value set to v.

func (OptURI) Get 

func (o OptURI) Get() (v url.URL, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptURI) IsSet 

func (o OptURI) IsSet() bool

IsSet returns true if OptURI was set.

func (OptURI) Or 

func (o OptURI) Or(d url.URL) url.URL

Or returns value if set, or given parameter if does not.

func (*OptURI) Reset 

func (o *OptURI) Reset()

Reset unsets value.

func (*OptURI) SetTo 

func (o *OptURI) SetTo(v url.URL)

SetTo sets value to v.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type Route 

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

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type Server 

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

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

func NewServer(h Handler, opts ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath 

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) Begin 

func (UnimplementedHandler) Begin(ctx context.Context, params BeginParams) (r BeginRes, _ error)

Begin implements begin operation.

Begin.

GET /auth

func (UnimplementedHandler) Callback 

func (UnimplementedHandler) Callback(ctx context.Context, params CallbackParams) (r CallbackRes, _ error)

Callback implements callback operation.

Callback.

GET /callback

func (UnimplementedHandler) End 

func (UnimplementedHandler) End(ctx context.Context, req *EndReq) (r EndRes, _ error)

End implements end operation.

End.

POST /auth

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.