coderutil

Documentation

Overview

Package coderutil providers utilities for high-level operations on coder-sdk entities.

Index

• func DialEnvWsep(ctx context.Context, client *coder.Client, env *coder.Environment) (*websocket.Conn, error)
• type EnvWithWorkspaceProvider
  • func EnvsWithProvider(ctx context.Context, client *coder.Client, envs []coder.Environment) ([]EnvWithWorkspaceProvider, error)

Functions

func DialEnvWsep

func DialEnvWsep(ctx context.Context, client *coder.Client, env *coder.Environment) (*websocket.Conn, error)

DialEnvWsep dials the executor endpoint using the https://github.com/cdr/wsep message protocol. The proper workspace provider envproxy access URL is used.

Types

type EnvWithWorkspaceProvider

type EnvWithWorkspaceProvider struct {
	Env               coder.Environment
	WorkspaceProvider coder.WorkspaceProvider
}

EnvWithWorkspaceProvider composes an Environment entity with its associated WorkspaceProvider.

func EnvsWithProvider

func EnvsWithProvider(ctx context.Context, client *coder.Client, envs []coder.Environment) ([]EnvWithWorkspaceProvider, error)

EnvsWithProvider performs the composition of each Environment with its associated WorkspaceProvider.