Method ReadFileLines

codersdk/workspacesdk/agentconn.go:964–990

ReadFileLines reads a file with line-based offset and limit, returning line-numbered content with safety limits.

(ctx context.Context, path string, offset, limit int64, limits ReadFileLinesLimits)

// ReadFileLines reads a file with line-based offset and limit, returning
// line-numbered content with safety limits.
func (c *agentConn) ReadFileLines(ctx context.Context, path string, offset, limit int64, limits ReadFileLinesLimits) (ReadFileLinesResponse, error) {
	ctx, span := tracing.StartSpan(ctx)
	defer span.End()

	res, err := c.apiRequest(ctx, http.MethodGet, agentAPIPath("/api/v0/read-file-lines", neturl.Values{
		"path":               []string{path},
		"offset":             []string{strconv.FormatInt(offset, 10)},
		"limit":              []string{strconv.FormatInt(limit, 10)},
		"max_file_size":      []string{strconv.FormatInt(limits.MaxFileSize, 10)},
		"max_line_bytes":     []string{strconv.Itoa(limits.MaxLineBytes)},
		"max_response_lines": []string{strconv.Itoa(limits.MaxResponseLines)},
		"max_response_bytes": []string{strconv.Itoa(limits.MaxResponseBytes)},
	}), nil)
	if err != nil {
		return ReadFileLinesResponse{}, xerrors.Errorf("do request: %w", err)
	}
	defer res.Body.Close()
	if res.StatusCode != http.StatusOK {
		return ReadFileLinesResponse{}, codersdk.ReadBodyAsError(res)
	}

	var resp ReadFileLinesResponse
	if err := json.NewDecoder(res.Body).Decode(&resp); err != nil {
		return ReadFileLinesResponse{}, xerrors.Errorf("decode response: %w", err)
	}
	return resp, nil
}

// ReadFile reads from a file from the workspace, returning a file reader and
// the mime type.