print

Documentation

Index

• Variables
• func NewToolsPrintCmd[B firecore.Block](chain *firecore.Chain[B], logger *zap.Logger) *cobra.Command
• func PrintOutputModeNames() []string
• type BytesOutputPrinter
  • func NewBytesOutputPrinter(bytesEncoding string, registry *fcproto.Registry) *BytesOutputPrinter
  • func (p *BytesOutputPrinter) PrintTo(input any, out io.Writer) error
• type JSONOutputPrinter
  • func (p *JSONOutputPrinter) PrintTo(input any, w io.Writer) error
• type OutputPrinter
  • func GetOutputPrinter(cmd *cobra.Command, chainFileDescriptor protoreflect.FileDescriptor) (OutputPrinter, error)
  • func NewJSONOutputPrinter(bytesEncoding string, singleLine bool, registry *fcproto.Registry) (OutputPrinter, error)
• type PrintOutputMode
  • func ParsePrintOutputMode(name string) (PrintOutputMode, error)
  • func (x PrintOutputMode) IsValid() bool
  • func (x PrintOutputMode) MarshalText() ([]byte, error)
  • func (x PrintOutputMode) String() string
  • func (x *PrintOutputMode) UnmarshalText(text []byte) error
• type ProtoJSONOutputPrinter
  • func NewProtoJSONOutputPrinter(indent string, registry *fcproto.Registry) *ProtoJSONOutputPrinter
  • func (p *ProtoJSONOutputPrinter) PrintTo(input any, w io.Writer) error
• type TextOutputPrinter
  • func NewTextOutputPrinter(bytesEncoding string, registry *fcproto.Registry, printTransactions bool) *TextOutputPrinter
  • func (p *TextOutputPrinter) PrintTo(input any, out io.Writer) error

Variables

var ErrInvalidPrintOutputMode = fmt.Errorf("not a valid PrintOutputMode, try [%s]", strings.Join(_PrintOutputModeNames, ", "))

Functions

func NewToolsPrintCmd

func NewToolsPrintCmd[B firecore.Block](chain *firecore.Chain[B], logger *zap.Logger) *cobra.Command

func PrintOutputModeNames

func PrintOutputModeNames() []string

PrintOutputModeNames returns a list of possible string values of PrintOutputMode.

Types

type BytesOutputPrinter

type BytesOutputPrinter struct {
	// contains filtered or unexported fields
}

func NewBytesOutputPrinter

func NewBytesOutputPrinter(bytesEncoding string, registry *fcproto.Registry) *BytesOutputPrinter

func (*BytesOutputPrinter) PrintTo

func (p *BytesOutputPrinter) PrintTo(input any, out io.Writer) error

type JSONOutputPrinter

type JSONOutputPrinter struct {
	// contains filtered or unexported fields
}

func (*JSONOutputPrinter) PrintTo

func (p *JSONOutputPrinter) PrintTo(input any, w io.Writer) error

type OutputPrinter

type OutputPrinter interface {
	PrintTo(message any, w io.Writer) error
}

func GetOutputPrinter

func GetOutputPrinter(cmd *cobra.Command, chainFileDescriptor protoreflect.FileDescriptor) (OutputPrinter, error)

func NewJSONOutputPrinter

func NewJSONOutputPrinter(bytesEncoding string, singleLine bool, registry *fcproto.Registry) (OutputPrinter, error)

type PrintOutputMode

type PrintOutputMode uint

ENUM(Text, JSON, JSONL, ProtoJSON, ProtoJSONL, Bytes)

const (
	// PrintOutputModeText is a PrintOutputMode of type Text.
	PrintOutputModeText PrintOutputMode = iota
	// PrintOutputModeJSON is a PrintOutputMode of type JSON.
	PrintOutputModeJSON
	// PrintOutputModeJSONL is a PrintOutputMode of type JSONL.
	PrintOutputModeJSONL
	// PrintOutputModeProtoJSON is a PrintOutputMode of type ProtoJSON.
	PrintOutputModeProtoJSON
	// PrintOutputModeProtoJSONL is a PrintOutputMode of type ProtoJSONL.
	PrintOutputModeProtoJSONL
	// PrintOutputModeBytes is a PrintOutputMode of type Bytes.
	PrintOutputModeBytes
)

func ParsePrintOutputMode

func ParsePrintOutputMode(name string) (PrintOutputMode, error)

ParsePrintOutputMode attempts to convert a string to a PrintOutputMode.

func (PrintOutputMode) IsValid

func (x PrintOutputMode) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (PrintOutputMode) MarshalText

func (x PrintOutputMode) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method.

func (PrintOutputMode) String

func (x PrintOutputMode) String() string

String implements the Stringer interface.

func (*PrintOutputMode) UnmarshalText

func (x *PrintOutputMode) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method.

type ProtoJSONOutputPrinter

type ProtoJSONOutputPrinter struct {
	// contains filtered or unexported fields
}

func NewProtoJSONOutputPrinter

func NewProtoJSONOutputPrinter(indent string, registry *fcproto.Registry) *ProtoJSONOutputPrinter

func (*ProtoJSONOutputPrinter) PrintTo

func (p *ProtoJSONOutputPrinter) PrintTo(input any, w io.Writer) error

type TextOutputPrinter

type TextOutputPrinter struct {
	// contains filtered or unexported fields
}

func NewTextOutputPrinter

func NewTextOutputPrinter(bytesEncoding string, registry *fcproto.Registry, printTransactions bool) *TextOutputPrinter

func (*TextOutputPrinter) PrintTo

func (p *TextOutputPrinter) PrintTo(input any, out io.Writer) error