package tabwriter

Import Path
	text/tabwriter (on golang.org and go.dev)

Dependency Relation
	imports 2 packages, and imported by 2 packages

Involved Source Files
	d-> tabwriter.go

Exported Type Names

type Writer (struct) A Writer is a filter that inserts padding around tab-delimited columns in its input to align them in the output. The Writer treats incoming bytes as UTF-8-encoded text consisting of cells terminated by horizontal ('\t') or vertical ('\v') tabs, and newline ('\n') or formfeed ('\f') characters; both newline and formfeed act as line breaks. Tab-terminated cells in contiguous lines constitute a column. The Writer inserts padding as needed to make all cells in a column have the same width, effectively aligning the columns. It assumes that all characters have the same width, except for tabs for which a tabwidth must be specified. Column cells must be tab-terminated, not tab-separated: non-tab terminated trailing text at the end of a line forms a cell but that cell is not part of an aligned column. For instance, in this example (where | stands for a horizontal tab): aaaa|bbb|d aa |b |dd a | aa |cccc|eee the b and c are in distinct columns (the b column is not contiguous all the way). The d and e are not in a column at all (there's no terminating tab, nor would the column be contiguous). The Writer assumes that all Unicode code points have the same width; this may not be true in some fonts or if the string contains combining characters. If DiscardEmptyColumns is set, empty columns that are terminated entirely by vertical (or "soft") tabs are discarded. Columns terminated by horizontal (or "hard") tabs are not affected by this flag. If a Writer is configured to filter HTML, HTML tags and entities are passed through. The widths of tags and entities are assumed to be zero (tags) and one (entities) for formatting purposes. A segment of text may be escaped by bracketing it with Escape characters. The tabwriter passes escaped text segments through unchanged. In particular, it does not interpret any tabs or line breaks within the segment. If the StripEscape flag is set, the Escape characters are stripped from the output; otherwise they are passed through as well. For the purpose of formatting, the width of the escaped text is always computed excluding the Escape characters. The formfeed character acts like a newline but it also terminates all columns in the current line (effectively calling Flush). Tab- terminated cells in the next line start new columns. Unless found inside an HTML tag or inside an escaped text segment, formfeed characters appear as newlines in the output. The Writer must buffer input internally, because proper spacing of one line may depend on the cells in future lines. Clients must call Flush when done calling Write. (*T) Flush() error (*T) Init(output io.Writer, minwidth, tabwidth, padding int, padchar byte, flags uint) *Writer (*T) Write(buf []byte) (n int, err error) *T : io.Writer func NewWriter(output io.Writer, minwidth, tabwidth, padding int, padchar byte, flags uint) *Writer func (*Writer).Init(output io.Writer, minwidth, tabwidth, padding int, padchar byte, flags uint) *Writer
Exported Values
const AlignRight uint = 4 Force right-alignment of cell content. Default is left-alignment.
const Debug uint = 32 Print a vertical bar ('|') between columns (after formatting). Discarded columns appear as zero-width columns ("||").
const DiscardEmptyColumns uint = 8 Handle empty columns as if they were not present in the input in the first place.
const Escape = 255 To escape a text segment, bracket it with Escape characters. For instance, the tab in this string "Ignore this tab: \xff\t\xff" does not terminate a cell and constitutes a single character of width one for formatting purposes. The value 0xff was chosen because it cannot appear in a valid UTF-8 sequence.
const FilterHTML uint = 1 Ignore html tags and treat entities (starting with '&' and ending in ';') as single characters (width = 1).
func NewWriter(output io.Writer, minwidth, tabwidth, padding int, padchar byte, flags uint) *Writer NewWriter allocates and initializes a new tabwriter.Writer. The parameters are the same as for the Init function.
const StripEscape uint = 2 Strip Escape characters bracketing escaped text segments instead of passing them through unchanged with the text.
const TabIndent uint = 16 Always use tabs for indentation columns (i.e., padding of leading empty cells on the left) independent of padchar.