package context

Import Path
	context (on golang.org and go.dev)

Dependency Relation
	imports 5 packages, and imported by 13 packages

Involved Source Files
	d-> context.go

Exported Type Names


	 type CancelFunc (func)
		A CancelFunc tells an operation to abandon its work.
		A CancelFunc does not wait for the work to stop.
		A CancelFunc may be called by multiple goroutines simultaneously.
		After the first call, subsequent calls to a CancelFunc do nothing.

		
			func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
			func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
			func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)


	 type Context (interface)
		A Context carries a deadline, a cancellation signal, and other values across
		API boundaries.

		Context's methods may be called by multiple goroutines simultaneously.

		
			 (T) Deadline() (deadline time.Time, ok bool)
			 (T) Done() <-chan struct{}
			 (T) Err() error
			 (T) Value(key interface{}) interface{}
		
			func Background() Context
			func TODO() Context
			func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
			func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
			func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
			func WithValue(parent Context, key, val interface{}) Context
			func net/http.(*Request).Context() Context
			func net/http/httptrace.WithClientTrace(ctx Context, trace *httptrace.ClientTrace) Context
		
			func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
			func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
			func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
			func WithValue(parent Context, key, val interface{}) Context
			func crypto/tls.(*Dialer).DialContext(ctx Context, network, addr string) (net.Conn, error)
			func database/sql.(*Conn).BeginTx(ctx Context, opts *sql.TxOptions) (*sql.Tx, error)
			func database/sql.(*Conn).ExecContext(ctx Context, query string, args ...interface{}) (sql.Result, error)
			func database/sql.(*Conn).PingContext(ctx Context) error
			func database/sql.(*Conn).PrepareContext(ctx Context, query string) (*sql.Stmt, error)
			func database/sql.(*Conn).QueryContext(ctx Context, query string, args ...interface{}) (*sql.Rows, error)
			func database/sql.(*Conn).QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func database/sql.(*DB).BeginTx(ctx Context, opts *sql.TxOptions) (*sql.Tx, error)
			func database/sql.(*DB).Conn(ctx Context) (*sql.Conn, error)
			func database/sql.(*DB).ExecContext(ctx Context, query string, args ...interface{}) (sql.Result, error)
			func database/sql.(*DB).PingContext(ctx Context) error
			func database/sql.(*DB).PrepareContext(ctx Context, query string) (*sql.Stmt, error)
			func database/sql.(*DB).QueryContext(ctx Context, query string, args ...interface{}) (*sql.Rows, error)
			func database/sql.(*DB).QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func database/sql.(*Stmt).ExecContext(ctx Context, args ...interface{}) (sql.Result, error)
			func database/sql.(*Stmt).QueryContext(ctx Context, args ...interface{}) (*sql.Rows, error)
			func database/sql.(*Stmt).QueryRowContext(ctx Context, args ...interface{}) *sql.Row
			func database/sql.(*Tx).ExecContext(ctx Context, query string, args ...interface{}) (sql.Result, error)
			func database/sql.(*Tx).PrepareContext(ctx Context, query string) (*sql.Stmt, error)
			func database/sql.(*Tx).QueryContext(ctx Context, query string, args ...interface{}) (*sql.Rows, error)
			func database/sql.(*Tx).QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func database/sql.(*Tx).StmtContext(ctx Context, stmt *sql.Stmt) *sql.Stmt
			func database/sql/driver.ConnBeginTx.BeginTx(ctx Context, opts driver.TxOptions) (driver.Tx, error)
			func database/sql/driver.Connector.Connect(Context) (driver.Conn, error)
			func database/sql/driver.ConnPrepareContext.PrepareContext(ctx Context, query string) (driver.Stmt, error)
			func database/sql/driver.ExecerContext.ExecContext(ctx Context, query string, args []driver.NamedValue) (driver.Result, error)
			func database/sql/driver.Pinger.Ping(ctx Context) error
			func database/sql/driver.QueryerContext.QueryContext(ctx Context, query string, args []driver.NamedValue) (driver.Rows, error)
			func database/sql/driver.SessionResetter.ResetSession(ctx Context) error
			func database/sql/driver.StmtExecContext.ExecContext(ctx Context, args []driver.NamedValue) (driver.Result, error)
			func database/sql/driver.StmtQueryContext.QueryContext(ctx Context, args []driver.NamedValue) (driver.Rows, error)
			func gorm.io/gorm.ConnPool.ExecContext(ctx Context, query string, args ...interface{}) (sql.Result, error)
			func gorm.io/gorm.ConnPool.PrepareContext(ctx Context, query string) (*sql.Stmt, error)
			func gorm.io/gorm.ConnPool.QueryContext(ctx Context, query string, args ...interface{}) (*sql.Rows, error)
			func gorm.io/gorm.ConnPool.QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func gorm.io/gorm.ConnPoolBeginner.BeginTx(ctx Context, opts *sql.TxOptions) (gorm.ConnPool, error)
			func gorm.io/gorm.(*DB).WithContext(ctx Context) *gorm.DB
			func gorm.io/gorm.(*PreparedStmtDB).BeginTx(ctx Context, opt *sql.TxOptions) (gorm.ConnPool, error)
			func gorm.io/gorm.(*PreparedStmtDB).ExecContext(ctx Context, query string, args ...interface{}) (result sql.Result, err error)
			func gorm.io/gorm.(*PreparedStmtDB).QueryContext(ctx Context, query string, args ...interface{}) (rows *sql.Rows, err error)
			func gorm.io/gorm.(*PreparedStmtDB).QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func gorm.io/gorm.(*PreparedStmtTX).ExecContext(ctx Context, query string, args ...interface{}) (result sql.Result, err error)
			func gorm.io/gorm.(*PreparedStmtTX).QueryContext(ctx Context, query string, args ...interface{}) (rows *sql.Rows, err error)
			func gorm.io/gorm.(*PreparedStmtTX).QueryRowContext(ctx Context, query string, args ...interface{}) *sql.Row
			func gorm.io/gorm.TxBeginner.BeginTx(ctx Context, opts *sql.TxOptions) (*sql.Tx, error)
			func gorm.io/gorm.Valuer.GormValue(Context, *gorm.DB) clause.Expr
			func gorm.io/gorm/logger.Interface.Error(Context, string, ...interface{})
			func gorm.io/gorm/logger.Interface.Info(Context, string, ...interface{})
			func gorm.io/gorm/logger.Interface.Trace(ctx Context, begin time.Time, fc func() (string, int64), err error)
			func gorm.io/gorm/logger.Interface.Warn(Context, string, ...interface{})
			func net.(*Dialer).DialContext(ctx Context, network, address string) (net.Conn, error)
			func net.(*ListenConfig).Listen(ctx Context, network, address string) (net.Listener, error)
			func net.(*ListenConfig).ListenPacket(ctx Context, network, address string) (net.PacketConn, error)
			func net.(*Resolver).LookupAddr(ctx Context, addr string) (names []string, err error)
			func net.(*Resolver).LookupCNAME(ctx Context, host string) (cname string, err error)
			func net.(*Resolver).LookupHost(ctx Context, host string) (addrs []string, err error)
			func net.(*Resolver).LookupIP(ctx Context, network, host string) ([]net.IP, error)
			func net.(*Resolver).LookupIPAddr(ctx Context, host string) ([]net.IPAddr, error)
			func net.(*Resolver).LookupMX(ctx Context, name string) ([]*net.MX, error)
			func net.(*Resolver).LookupNS(ctx Context, name string) ([]*net.NS, error)
			func net.(*Resolver).LookupPort(ctx Context, network, service string) (port int, err error)
			func net.(*Resolver).LookupSRV(ctx Context, service, proto, name string) (cname string, addrs []*net.SRV, err error)
			func net.(*Resolver).LookupTXT(ctx Context, name string) ([]string, error)
			func net/http.NewRequestWithContext(ctx Context, method, url string, body io.Reader) (*http.Request, error)
			func net/http.(*Request).Clone(ctx Context) *http.Request
			func net/http.(*Request).WithContext(ctx Context) *http.Request
			func net/http.(*Server).Shutdown(ctx Context) error
			func net/http/httptrace.ContextClientTrace(ctx Context) *httptrace.ClientTrace
			func net/http/httptrace.WithClientTrace(ctx Context, trace *httptrace.ClientTrace) Context

Exported Values


	 func Background() Context
		Background returns a non-nil, empty Context. It is never canceled, has no
		values, and has no deadline. It is typically used by the main function,
		initialization, and tests, and as the top-level Context for incoming
		requests.


	  var Canceled error
		Canceled is the error returned by Context.Err when the context is canceled.


	  var DeadlineExceeded error
		DeadlineExceeded is the error returned by Context.Err when the context's
		deadline passes.


	 func TODO() Context
		TODO returns a non-nil, empty Context. Code should use context.TODO when
		it's unclear which Context to use or it is not yet available (because the
		surrounding function has not yet been extended to accept a Context
		parameter).


	 func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
		WithCancel returns a copy of parent with a new Done channel. The returned
		context's Done channel is closed when the returned cancel function is called
		or when the parent context's Done channel is closed, whichever happens first.

		Canceling this context releases resources associated with it, so code should
		call cancel as soon as the operations running in this Context complete.


	 func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
		WithDeadline returns a copy of the parent context with the deadline adjusted
		to be no later than d. If the parent's deadline is already earlier than d,
		WithDeadline(parent, d) is semantically equivalent to parent. The returned
		context's Done channel is closed when the deadline expires, when the returned
		cancel function is called, or when the parent context's Done channel is
		closed, whichever happens first.

		Canceling this context releases resources associated with it, so code should
		call cancel as soon as the operations running in this Context complete.


	 func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
		WithTimeout returns WithDeadline(parent, time.Now().Add(timeout)).

		Canceling this context releases resources associated with it, so code should
		call cancel as soon as the operations running in this Context complete:

			func slowOperationWithTimeout(ctx context.Context) (Result, error) {
				ctx, cancel := context.WithTimeout(ctx, 100*time.Millisecond)
				defer cancel()  // releases resources if slowOperation completes before timeout elapses
				return slowOperation(ctx)
			}


	 func WithValue(parent Context, key, val interface{}) Context
		WithValue returns a copy of parent in which the value associated with key is
		val.

		Use context Values only for request-scoped data that transits processes and
		APIs, not for passing optional parameters to functions.

		The provided key must be comparable and should not be of type
		string or any other built-in type to avoid collisions between
		packages using context. Users of WithValue should define their own
		types for keys. To avoid allocating when assigning to an
		interface{}, context keys often have concrete type
		struct{}. Alternatively, exported context key variables' static
		type should be a pointer or interface.