sashakoshka/go-gemini
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

client: Clarify usage of contexts

Browse Source
This commit is contained in:
Adnan Maolood 2021-02-23 18:56:18 -05:00
parent a7c449a3cf
commit b3e8d9ccf3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
client.go
View File

@ -30,8 +30,9 @@ type Client struct {
} }
// Get sends a Gemini request for the given URL. // Get sends a Gemini request for the given URL.
// If the provided context is canceled or times out, the request // The context controls the entire lifetime of a request and its response:
// is aborted and the context's error is returned. // obtaining a connection, sending the request, and reading the response
// header and body.
// //
// An error is returned if there was a Gemini protocol error. // An error is returned if there was a Gemini protocol error.
// A non-2x status code doesn't cause an error. // A non-2x status code doesn't cause an error.
@ -48,15 +49,14 @@ func (c *Client) Get(ctx context.Context, url string) (*Response, error) {
} }
// Do sends a Gemini request and returns a Gemini response. // Do sends a Gemini request and returns a Gemini response.
// If the provided context is canceled or times out, the request // The context controls the entire lifetime of a request and its response:
// is aborted and the context's error is returned. // obtaining a connection, sending the request, and reading the response
// header and body.
// //
// An error is returned if there was a Gemini protocol error. // An error is returned if there was a Gemini protocol error.
// A non-2x status code doesn't cause an error. // A non-2x status code doesn't cause an error.
// //
// If the returned error is nil, the user is expected to close the Response. // If the returned error is nil, the user is expected to close the Response.
//
// Generally Get will be used instead of Do.
func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) { func (c *Client) Do(ctx context.Context, req *Request) (*Response, error) {
if ctx == nil { if ctx == nil {
panic("nil context") panic("nil context")