desktop

Documentation

Index

• Variables
• func GetToken(ctx context.Context) string
• func GetUUID(ctx context.Context) string
• func GetVersion(ctx context.Context) string
• func IsDockerDesktopRunning(ctx context.Context) bool
• func IsWSL() bool
• type DockerDesktopPaths
• type DockerHubInfo
  • func GetUserInfo(ctx context.Context) DockerHubInfo
• type RawClient
  • func (c *RawClient) Get(ctx context.Context, endpoint string, v any) error

Variables

var ClientBackend = newRawClient(dialBackend)

var Paths = sync.OnceValue(func() DockerDesktopPaths {
	desktopPaths, err := getDockerDesktopPaths()
	if err != nil {
		panic(err)
	}

	return desktopPaths
})

Functions

func GetToken

func GetToken(ctx context.Context) string

func GetUUID

func GetUUID(ctx context.Context) string

func GetVersion

func GetVersion(ctx context.Context) string

GetVersion returns the running Docker Desktop version (e.g. "4.74.0") or an empty string if Docker Desktop is not running or the call fails.

The lookup is bounded by a short internal timeout so a stale or missing backend socket cannot stall callers on hot paths (it is queried on every outbound built-in tool HTTP request). ctx is used for the underlying HTTP call on a cache miss; on a cache hit the cached value is returned without consulting ctx.

func IsDockerDesktopRunning

func IsDockerDesktopRunning(ctx context.Context) bool

func IsWSL

func IsWSL() bool

Types

type DockerDesktopPaths

type DockerDesktopPaths struct {
	BackendSocket string
	ProxySocket   string
}

type DockerHubInfo

type DockerHubInfo struct {
	Username string `json:"id"`
	Email    string `json:"email,omitempty"`
}

func GetUserInfo

func GetUserInfo(ctx context.Context) DockerHubInfo

type RawClient

type RawClient struct {
	// contains filtered or unexported fields
}

func (*RawClient) Get

func (c *RawClient) Get(ctx context.Context, endpoint string, v any) error