format

Documentation

Overview

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com> SPDX-License-Identifier: BSD-3-Clause

Index

• func GetRows(v any, cols config.Columns, explode bool) ([][]string, error)
• func IsTerminal(w io.Writer) bool
• type Base64
  • func (Base64) Error(ctx context.Context, v any) error
  • func (b Base64) Format(ctx context.Context, w io.Writer, v any) error
• type Body
  • func (Body) Error(ctx context.Context, v any) error
  • func (Body) Format(ctx context.Context, w io.Writer, v any) (err error)
• type CSVFormatter
  • func (f CSVFormatter) Format(ctx context.Context, w io.Writer, headers []string, data [][]string) error
• type Interface
• type JSON
  • func (j JSON) Error(ctx context.Context, v any) error
  • func (JSON) Format(ctx context.Context, w io.Writer, v any) error
• type None
  • func (None) Error(ctx context.Context, v any) error
  • func (None) Format(ctx context.Context, _ io.Writer, _ any) error
• type Single
  • func (s Single) Error(ctx context.Context, v any) error
  • func (s Single) Format(ctx context.Context, w io.Writer, v any) error
• type Success
  • func (Success) Error(ctx context.Context, v any) error
  • func (Success) Format(ctx context.Context, w io.Writer, v any) error
• type TableFormatter
  • func (f TableFormatter) Format(ctx context.Context, w io.Writer, headers []string, data [][]string) error
• type Tabular
  • func (Tabular) Error(ctx context.Context, v any) error
  • func (t Tabular) Format(ctx context.Context, w io.Writer, v any) error
• type TabularFormatter
• type YAML
  • func (y YAML) Error(ctx context.Context, v any) error
  • func (YAML) Format(ctx context.Context, w io.Writer, v any) error

Functions

func GetRows

func GetRows(v any, cols config.Columns, explode bool) ([][]string, error)

GetRows return one or multiple rows based on a single entry.

func IsTerminal

func IsTerminal(w io.Writer) bool

Types

type Base64

type Base64 struct{}

func (Base64) Error

func (Base64) Error(ctx context.Context, v any) error

func (Base64) Format

func (b Base64) Format(ctx context.Context, w io.Writer, v any) error

type Body

type Body struct{}

func (Body) Error

func (Body) Error(ctx context.Context, v any) error

func (Body) Format

func (Body) Format(ctx context.Context, w io.Writer, v any) (err error)

type CSVFormatter

type CSVFormatter struct{}

func (CSVFormatter) Format

func (f CSVFormatter) Format(ctx context.Context, w io.Writer, headers []string, data [][]string) error

type Interface

type Interface interface {
	Format(ctx context.Context, w io.Writer, v any) error
	Error(ctx context.Context, v any) error
}

type JSON

type JSON struct{}

func (JSON) Error

func (j JSON) Error(ctx context.Context, v any) error

func (JSON) Format

func (JSON) Format(ctx context.Context, w io.Writer, v any) error

type None

type None struct{}

func (None) Error

func (None) Error(ctx context.Context, v any) error

func (None) Format

func (None) Format(ctx context.Context, _ io.Writer, _ any) error

type Single

type Single struct {
	ForFormat Interface
}

func (Single) Error

func (s Single) Error(ctx context.Context, v any) error

func (Single) Format

func (s Single) Format(ctx context.Context, w io.Writer, v any) error

type Success

type Success struct{}

func (Success) Error

func (Success) Error(ctx context.Context, v any) error

func (Success) Format

func (Success) Format(ctx context.Context, w io.Writer, v any) error

type TableFormatter

type TableFormatter struct{}

func (TableFormatter) Format

func (f TableFormatter) Format(ctx context.Context, w io.Writer, headers []string, data [][]string) error

type Tabular

type Tabular struct {
	Explode, Sort bool
	Columns       config.Columns

	Formatter TabularFormatter
}

func (Tabular) Error

func (Tabular) Error(ctx context.Context, v any) error

func (Tabular) Format

func (t Tabular) Format(ctx context.Context, w io.Writer, v any) error

type TabularFormatter

type TabularFormatter interface {
	Format(ctx context.Context, w io.Writer, header []string, data [][]string) error
}

type YAML

type YAML struct{}

func (YAML) Error

func (y YAML) Error(ctx context.Context, v any) error

func (YAML) Format

func (YAML) Format(ctx context.Context, w io.Writer, v any) error