package tgerr

Import Path
	github.com/gotd/td/tgerr (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 6 packages

Involved Source Files

	  d error.go
		Package tgerr implements helpers for error handling.

	    flood_wait.go
Package-Level Type Names (total 4, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Error (struct)
		Error represents RPC error returned as result to request.

		Fields (total 4, all are exported)
			Argument int
				// 3

			Code int
				// 420

			Message string
				// FLOOD_WAIT_3

			Type string
				// FLOOD_WAIT

		Methods (total 6, in which 5 are exported)
			(*Error) Error() string
			(*Error) IsCode(code int) bool
				IsCode reports whether error Code is equal to code.

			(*Error) IsCodeOneOf(codes ...int) bool
				IsCodeOneOf returns true if error code is one of codes.

			(*Error) IsOneOf(tt ...string) bool
				IsOneOf returns true if error type is in tt.

			(*Error) IsType(t string) bool
				IsType reports whether error has type t.

			/* one unexported ... *//* one unexported: */
			(*Error) extractArgument()
				extractArgument extracts Type and Argument from Message.

		Implements (at least one exported)
			*Error : error
		As Outputs Of (at least 3, all are exported)
			func As(err error) (rpcErr *Error, ok bool)
			func AsType(err error, t string) (rpcErr *Error, ok bool)
			func New(code int, msg string) *Error

	 type FloodWaitOption (interface)
		FloodWaitOption configures flood wait.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( FloodWaitOption) apply(o *floodWaitOptions)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 floodWaitOptionFunc
		As Outputs Of (at least one exported)
			func FloodWaitWithClock(c clock.Clock) FloodWaitOption
		As Inputs Of (at least one exported)
			func FloodWait(ctx context.Context, err error, opts ...FloodWaitOption) (bool, error)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type floodWaitOptionFunc (func)

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( floodWaitOptionFunc) apply(o *floodWaitOptions)
		Implements (at least one exported)
			 floodWaitOptionFunc : FloodWaitOption

	 type floodWaitOptions (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			clock clock.Clock


Package-Level Functions (total 8, all are exported)

	 func As(err error) (rpcErr *Error, ok bool)
		As extracts *Error from err if possible.

	 func AsFloodWait(err error) (d time.Duration, ok bool)
		AsFloodWait returns wait duration and true boolean if err is
		the "FLOOD_WAIT" error.
		
		Client should wait for that duration before issuing new requests with
		same method.

	 func AsType(err error, t string) (rpcErr *Error, ok bool)
		AsType returns *Error from err if rpc error type is t.

	 func FloodWait(ctx context.Context, err error, opts ...FloodWaitOption) (bool, error)
		FloodWait sleeps required duration and returns true if err is FLOOD_WAIT
		or false and context or original error otherwise.

	 func FloodWaitWithClock(c clock.Clock) FloodWaitOption
		FloodWaitWithClock sets time source for flood wait.

	 func Is(err error, tt ...string) bool
		Is returns true if err type is t.

	 func IsCode(err error, code ...int) bool
		IsCode returns true of error code is as provided.

	 func New(code int, msg string) *Error
		New creates new *Error from code and message, extracting argument
		and type.


Package-Level Constants (only one, which is exported)

	const ErrFloodWait = "FLOOD_WAIT"
		ErrFloodWait is error type of "FLOOD_WAIT" error.

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.