Documentation
¶
Overview ¶
Package indentedWriter implements an io.Writer that prefaces each output line with a defined number of spaces.
Index ¶
- type IndentedWriter
- func (iw *IndentedWriter) Indent(n int) *IndentedWriter
- func (iw *IndentedWriter) NoIndent() *IndentedWriter
- func (iw *IndentedWriter) Print(a ...any) (n int, err error)
- func (iw *IndentedWriter) Printf(format string, a ...any) (n int, err error)
- func (iw *IndentedWriter) Println(a ...any) (n int, err error)
- func (iw *IndentedWriter) Write(b []byte) (n int, err error)
- type Printable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IndentedWriter ¶
type IndentedWriter struct {
// contains filtered or unexported fields
}
An io.Writer that prefixes each line with a defined number of spaces.
Note that IndentedWriter does not implement a Close() method, because there is no way to know how many other IndentedWriters may be simultaneously using the same output interface.
IndentedWriter is not safe for concurrency.
func IndentedWriterOn ¶
func IndentedWriterOn(out io.Writer) *IndentedWriter
Return a fresh IndentedWriter on the given Writer interface.
func (*IndentedWriter) Indent ¶
func (iw *IndentedWriter) Indent(n int) *IndentedWriter
Given an IndentedWriter, return a fresh IndentedWriter on the same Weiter interface whose start-of-line indentation is increased by n.
func (*IndentedWriter) NoIndent ¶
func (iw *IndentedWriter) NoIndent() *IndentedWriter
Given an IndentedWriter, return a fresh IndentedWriter on the same Weiter interface whose start-of-line indentation is zero.
When emitting indented output, this is useful for writing pragmas such as line number directives.
func (*IndentedWriter) Print ¶
func (iw *IndentedWriter) Print(a ...any) (n int, err error)
Method for Print, allowing IndentedWriter to subsume fmt
func (*IndentedWriter) Printf ¶
func (iw *IndentedWriter) Printf(format string, a ...any) (n int, err error)
Method for Printf, allowing IndentedWriter to subsume fmt
Source Files