Skip to content

Commit c371ad8

Browse files
Slightly simplify CredentialsProvider and add doc comments (#1169)
## What changes are proposed in this pull request? This PR is a noop that slightly refactors the `CredentialsProvider` and improve doc comments. ## How is this tested? Unit tests (no change) NO_CHANGELOG=true
1 parent 424a24b commit c371ad8

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

config/credentials/credentials.go

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,23 @@ import (
66
"golang.org/x/oauth2"
77
)
88

9-
// CredentialsProvider is an interface for providing credentials to the client.
10-
// Implementations of this interface should set the necessary headers on the request.
9+
// CredentialsProvider represents anything that can set credentials, such as
10+
// a token, in the headers of a request.
1111
type CredentialsProvider interface {
12-
// SetHeaders sets the necessary headers on the request.
12+
// SetHeaders sets the credential in the request's headers.
1313
SetHeaders(r *http.Request) error
1414
}
1515

16-
type credentialsProvider struct {
17-
setHeaders func(r *http.Request) error
18-
}
16+
type credentialsProvider func(r *http.Request) error
1917

20-
func (c *credentialsProvider) SetHeaders(r *http.Request) error {
21-
return c.setHeaders(r)
18+
func (c credentialsProvider) SetHeaders(r *http.Request) error {
19+
return c(r)
2220
}
2321

24-
func NewCredentialsProvider(visitor func(r *http.Request) error) CredentialsProvider {
25-
return &credentialsProvider{
26-
setHeaders: visitor,
27-
}
22+
// NewCredentialsProvider returns a new CredentialsProvider that uses the
23+
// provided function to set headers on the request.
24+
func NewCredentialsProvider(f func(r *http.Request) error) CredentialsProvider {
25+
return credentialsProvider(f)
2826
}
2927

3028
// OAuthCredentialsProvider is a specialized CredentialsProvider uses and provides an OAuth token.

0 commit comments

Comments
 (0)