truncate

package

v0.1.3 Latest Latest Go to latest Published: Jul 22, 2026 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/OrdalieTech/pigo

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func FormatSize(bytes int) string
func Int(value int) *int
type LineResult
- func TruncateLine(line string, maxChars ...int) LineResult
type Options
type Reason
type Result
- func TruncateHead(content string, options ...Options) Result
- func TruncateTail(content string, options ...Options) Result

Constants ¶

View Source

const (
	DefaultMaxLines   = 2000
	DefaultMaxBytes   = 50 * 1024
	GrepMaxLineLength = 500
)

Variables ¶

This section is empty.

Functions ¶

func FormatSize ¶

func FormatSize(bytes int) string

func Int ¶

func Int(value int) *int

Types ¶

type LineResult ¶

type LineResult struct {
	Text         string `json:"text"`
	WasTruncated bool   `json:"wasTruncated"`
}

func TruncateLine ¶

func TruncateLine(line string, maxChars ...int) LineResult

type Options ¶

type Options struct {
	MaxLines *int `json:"maxLines,omitempty"`
	MaxBytes *int `json:"maxBytes,omitempty"`
}

Options uses pointers because zero is an upstream-visible limit, while nil means the option was omitted and selects the default.

type Reason ¶

type Reason string

const (
	ReasonLines Reason = "lines"
	ReasonBytes Reason = "bytes"
)

type Result ¶

type Result struct {
	Content               string  `json:"content"`
	Truncated             bool    `json:"truncated"`
	TruncatedBy           *Reason `json:"truncatedBy"`
	TotalLines            int     `json:"totalLines"`
	TotalBytes            int     `json:"totalBytes"`
	OutputLines           int     `json:"outputLines"`
	OutputBytes           int     `json:"outputBytes"`
	LastLinePartial       bool    `json:"lastLinePartial"`
	FirstLineExceedsLimit bool    `json:"firstLineExceedsLimit"`
	MaxLines              int     `json:"maxLines"`
	MaxBytes              int     `json:"maxBytes"`
}

func TruncateHead ¶

func TruncateHead(content string, options ...Options) Result

func TruncateTail ¶

func TruncateTail(content string, options ...Options) Result

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL