output

Documentation

Overview

Package output formats nvfleetint command responses.

Index

• Constants
• func DisplayString(value string) string
• func FormatGeoLocation(location *nvfleetint.GeoLocation) string
• func FormatNameAndID(name, id string) string
• func FormatNameOrID(name, id string) string
• func FormatOptionalInt(value *int) string
• func FormatOptionalPercentage(value *float32) string
• func FormatStringList(values []string) string
• func IsValidFormat(format string) bool
• func Truncate(value string, maxRunes int) string
• func WriteJSON(w io.Writer, value any) error
• func WritePaginationFooter(w io.Writer, page Pagination) error
• func WriteRawJSON(w io.Writer, data []byte) error
• func WriteTable(w io.Writer, headers []string, rows [][]string) error
• type Pagination

Constants

const (
	FormatTable = "table"
	FormatJSON  = "json"
)

Functions

func DisplayString

func DisplayString(value string) string

Returns a printable placeholder for empty strings

func FormatGeoLocation

func FormatGeoLocation(location *nvfleetint.GeoLocation) string

Formats the most useful location label available

func FormatNameAndID

func FormatNameAndID(name, id string) string

Formats a display name with its stable identifier

func FormatNameOrID

func FormatNameOrID(name, id string) string

Returns the display name when present or the ID otherwise

func FormatOptionalInt

func FormatOptionalInt(value *int) string

Formats optional integers for table output

func FormatOptionalPercentage

func FormatOptionalPercentage(value *float32) string

Formats optional percentage values for table output

func FormatStringList

func FormatStringList(values []string) string

Formats non-empty strings as a comma-separated list

func IsValidFormat

func IsValidFormat(format string) bool

Reports whether format is a supported output format

func Truncate

func Truncate(value string, maxRunes int) string

Truncate shortens a single-line display value to at most maxRunes runes, replacing the trailing overflow with an ellipsis. It counts runes (not bytes) so multi-byte text is not cut mid-character. Table output is a human-friendly summary; the full value remains available via -o json.

func WriteJSON

func WriteJSON(w io.Writer, value any) error

Writes value as a single JSON document

func WritePaginationFooter

func WritePaginationFooter(w io.Writer, page Pagination) error

Writes the standard single-page pagination footer. Page carries the SDK's 0-based page number and is presented as the CLI's 1-based page.

func WriteRawJSON

func WriteRawJSON(w io.Writer, data []byte) error

Writes a raw JSON payload with a trailing newline

func WriteTable

func WriteTable(w io.Writer, headers []string, rows [][]string) error

Writes headers and rows as tab-aligned text

Types

type Pagination

type Pagination struct {
	Page     int
	PageSize int
	Total    int
}

Represents pagination metadata for table footers