client/buildkit: ClientOpts: update docs to use doc-links, and inline

inline the closures, and update the GoDoc to use doc-links to the related
buildkit function.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2023-08-01 11:27:33 +02:00
parent a1202648ff
commit 74d9850bb9
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C

View file

@ -10,19 +10,18 @@ import (
// ClientOpts returns a list of buildkit client options which allows the // ClientOpts returns a list of buildkit client options which allows the
// caller to create a buildkit client which will connect to the buildkit // caller to create a buildkit client which will connect to the buildkit
// API provided by the daemon. // API provided by the daemon. These options can be passed to [bkclient.New].
// //
// Example: bkclient.New(ctx, "", ClientOpts(c)...) // Example:
//
// bkclient.New(ctx, "", ClientOpts(c)...)
func ClientOpts(c client.CommonAPIClient) []bkclient.ClientOpt { func ClientOpts(c client.CommonAPIClient) []bkclient.ClientOpt {
session := func(ctx context.Context, proto string, meta map[string][]string) (net.Conn, error) {
return c.DialHijack(ctx, "/session", proto, meta)
}
grpc := func(ctx context.Context, _ string) (net.Conn, error) {
return c.DialHijack(ctx, "/grpc", "h2c", nil)
}
return []bkclient.ClientOpt{ return []bkclient.ClientOpt{
bkclient.WithSessionDialer(session), bkclient.WithSessionDialer(func(ctx context.Context, proto string, meta map[string][]string) (net.Conn, error) {
bkclient.WithContextDialer(grpc), return c.DialHijack(ctx, "/session", proto, meta)
}),
bkclient.WithContextDialer(func(ctx context.Context, _ string) (net.Conn, error) {
return c.DialHijack(ctx, "/grpc", "h2c", nil)
}),
} }
} }