view

Documentation

Overview

Package view contains the rendering logic for printing strict controls.

Index

• type Render
• type Writer
  • func NewWriter(writer io.Writer, render Render) *Writer
  • func (writer *Writer) DetailControl(control strict.Control) error
  • func (writer *Writer) List(controls strict.Controls) error

Types

type Render

type Render interface {
	// List renders the list of controls.
	List(controls strict.Controls) (string, error)

	// DetailControl renders the detailed information about the control, including its subcontrols.
	DetailControl(control strict.Control) (string, error)
}

type Writer

type Writer struct {
	io.Writer
	// contains filtered or unexported fields
}

Writer is the base layer for command views, encapsulating a set of I/O streams and implementing a human friendly view for strict controls.

func NewWriter

func NewWriter(writer io.Writer, render Render) *Writer

NewWriter returns a new `Writer` instance.

func (*Writer) DetailControl

func (writer *Writer) DetailControl(control strict.Control) error

DetailControl renders the detailed information about the control, including its subcontrols.

func (*Writer) List

func (writer *Writer) List(controls strict.Controls) error

List renders the given list of controls.