f_string

package
v0.1.25 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// DefaultIndentation is the default indentation string.
	DefaultIndentation string = "   "

	// DefaultSeparator is the default separator string.
	DefaultSeparator string = ", "
)

Variables

View Source 
var (
	// DefaultIndentationConfig is the default indentation configuration.
	DefaultIndentationConfig *IndentConfig

	// DefaultSeparatorConfig is the default separator configuration.
	DefaultSeparatorConfig *SeparatorConfig

	// DefaultFormatterConfig is the default formatter configuration.
	DefaultFormatterConfig *FormatterConfig
)
View Source 
var (
	// NBSP is the non-breaking space rune.
	NBSP rune
)

Functions

func ApplyForm 

func ApplyForm[T FStringer](form *FormatConfig, trav *Traversor, elem T) error

ApplyForm is a function that applies the format to an element.

Parameters:

  • form: The formatter to use for formatting.
  • trav: The traversor to use for formatting.
  • elem: The element to format.

Returns:

  • error: An error if the formatting fails.

Behaviors:

  • If the traversor is nil, the function does nothing.

func ApplyFormFunc 

func ApplyFormFunc[T any](form *FormatConfig, trav *Traversor, elem T, f FStringFunc[T]) error

ApplyFormFunc is a function that applies the format to an element.

Parameters:

  • form: The formatter to use for formatting.
  • trav: The traversor to use for formatting.
  • elem: The element to format.

Returns:

  • error: An error if the formatting fails.

Behaviors:

  • If the traversor is nil, the function does nothing.

func ApplyFormMany 

func ApplyFormMany[T FStringer](form *FormatConfig, trav *Traversor, elems []T) error

ApplyFormMany is a function that applies the format to multiple elements at once.

Parameters:

  • form: The formatter to use for formatting.
  • trav: The traversor to use for formatting.
  • elems: The elements to format.

Returns:

  • error: An error if type Errors.ErrAt if the formatting fails on a specific element.

Behaviors:

  • If the traversor is nil, the function does nothing.

func ApplyFormManyFunc 

func ApplyFormManyFunc[T any](form *FormatConfig, trav *Traversor, elems []T, f FStringFunc[T]) error

ApplyFormManyFunc is a function that applies the format to multiple elements at once.

Parameters:

  • form: The formatter to use for formatting.
  • trav: The traversor to use for formatting.
  • elems: The elements to format.

Returns:

  • error: An error if type Errors.ErrAt if the formatting fails on a specific element.

Behaviors:

  • If the traversor is nil, the function does nothing.

func ApplyFuncMany 

func ApplyFuncMany[T any](trav *Traversor, f FStringFunc[T], elems []T) error

ApplyFuncMany applies a format function to the StdPrinter.

Parameters:

  • p: The StdPrinter to use.
  • f: The function to apply.
  • elems: The elements to apply the function to.

Returns:

  • error: An error if the function fails.

Errors:

  • *ErrInvalidParameter: If the StdPrinter is nil.
  • *Errors.ErrAt: If an error occurs on a specific element.
  • any error returned by the function.

func ApplyMany 

func ApplyMany[T FStringer](trav *Traversor, elems []T) error

ApplyMany applies a format to a stringer.

Parameters:

  • p: The StdPrinter to use.
  • elems: The elements to format.

Returns:

  • error: An error if the formatting fails.

Errors:

  • *ErrInvalidParameter: If the StdPrinter is nil.
  • *ErrFinalization: If the finalization of the page fails.
  • *Errors.ErrAt: If an error occurs on a specific element.

Behaviors:

  • If the formatter is nil, the function uses the nil formatter.
  • If an element is nil, the function skips the element.
  • If all elements are nil, the function does nothing.

func ApplyTravFunc 

func ApplyTravFunc[T any](trav *Traversor, elem T, f FStringFunc[T]) error

ApplyTravFunc applies a function to the printer. Useful for when you want to apply a function that does not implement the FStringer interface.

Parameters:

  • trav: The traversor to use.
  • elem: The element to apply the function to.
  • f: The function to apply.

Returns:

  • error: An error if the function fails.

Errors:

  • *ErrFinalization: If the finalization of the page fails.
  • any error returned by the function.

func ApplyTravFuncMany 

func ApplyTravFuncMany[T any](trav *Traversor, f FStringFunc[T], elems []T) error

ApplyTravFuncMany applies a function to the printer. Useful for when you want to apply a function that does not implement the FStringer interface.

Parameters:

  • trav: The traversor to use.
  • f: The function to apply.
  • elems: The elements to apply the function to.

Returns:

  • error: An error if the function fails.

Errors:

  • *ErrFinalization: If the finalization of the page fails.
  • *Errors.ErrAt: If an error occurs on a specific element.
  • any error returned by the function.

func FStringArray 

func FStringArray(format *FormatConfig, values []string) (string, error)

FStringArray generates a formatted string representation of an array-like object.

Parameters:

  • format: The format to use for printing.
  • values: The values to print.

Returns:

  • string: The formatted string.
  • error: An error if the printing fails.

Behaviors:

  • If the format is nil, the function uses ArrayLikeFormat.

func NewStdPrinter 

func NewStdPrinter(form *FormatConfig) (*StdPrinter, *Traversor)

NewStdPrinter creates a new StdPrinter.

Parameters:

  • form: The formatter to use.

Returns:

  • *StdPrinter: The new StdPrinter.
  • *Traversor: The traversor of the StdPrinter.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func NewStdPrinterFromConfig 

func NewStdPrinterFromConfig(opts ...any) (*StdPrinter, *Traversor)

NewStdPrinterFromConfig creates a new StdPrinter from a configuration.

Parameters:

  • opts: The configuration to use.

Returns:

  • *StdPrinter: The new StdPrinter.
  • *Traversor: The traversor of the StdPrinter.

Behaviors:

  • If the configuration is nil, the function uses the default configuration.
  • Panics if an invalid configuration type is given (i.e., not IndentConfig, DelimiterConfig, or SeparatorConfig).

func Sfprint 

func Sfprint(form *FormatConfig, a ...interface{}) ([][][][]string, error)

Sfprint prints a formatted string.

Parameters:

  • form: The formatter to use.
  • a: The elements to print.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sfprintf 

func Sfprintf(form *FormatConfig, format string, a ...interface{}) ([][][][]string, error)

Sfprintf prints a formatted string.

Parameters:

  • form: The formatter to use.
  • format: The format string.
  • a: The elements to print.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sfprintln 

func Sfprintln(form *FormatConfig, a ...interface{}) ([][][][]string, error)

Sfprintln prints a formatted string with a newline.

Parameters:

  • form: The formatter to use.
  • a: The elements to print.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sprint 

func Sprint(form *FormatConfig, strs ...string) ([][][][]string, error)

Sprint prints strings.

Parameters:

  • form: The formatter to use.
  • strs: The strings to print.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error of type *common.ErrAt if the printing fails because of an invalid UTF-8 encoding.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func SprintFString 

func SprintFString[T FStringer](form *FormatConfig, elem T) ([][][][]string, error)

SprintFString prints a formatted string.

Parameters:

  • form: The formatter to use.
  • elem: The element to print.

Returns:

  • [][][][]string: The pages of the formatted string.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sprintj 

func Sprintj(form *FormatConfig, sep string, strs ...string) ([][][][]string, error)

Sprintj prints a joined string.

Parameters:

  • form: The formatter to use.
  • sep: The separator to use.
  • strs: The strings to join.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error of type *runes.ErrInvalidUTF8Encoding if the printing fails because of an invalid UTF-8 encoding.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sprintjln 

func Sprintjln(form *FormatConfig, sep string, lines ...string) ([][][][]string, error)

Sprintjln prints a joined string with a newline.

Parameters:

  • form: The formatter to use.
  • sep: The separator to use.
  • lines: The lines to join.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Sprintln 

func Sprintln(form *FormatConfig, lines ...string) ([][][][]string, error)

Sprintln prints a string with a newline.

Parameters:

  • form: The formatter to use.
  • lines: The lines to print.

Returns:

  • [][][][]string: The pages of the formatted strings.
  • error: An error if the printing fails.

Behaviors:

  • If the formatter is nil, the function uses the default formatter.

func Stringfy 

func Stringfy(doc [][][][]string, spacing int) []string

Stringify converts a formatted string to a string.

Parameters:

  • doc: The formatted string.
  • spacing: The spacing to use for the string.

Returns:

  • [][]string: The stringified formatted string.

Behaviors:

  • If the spacing is less than or equal to 0, the spacing is set to 1.

Types

type ConfigOption 

type ConfigOption func(*FormatConfig)

ConfigOption is a type that represents a configuration option for a formatter.

func WithLeftDelimiter 

func WithLeftDelimiter(str string) ConfigOption

WithLeftDelimiter is a function that modifies the left delimiter of the formatter.

Parameters:

  • str: The string to use as the left delimiter.

Returns:

  • ConfigOption: The configuration option.

Behaviors:

  • If str is empty, then the left delimiter is removed.

func WithModifiedIndent 

func WithModifiedIndent(by int) ConfigOption

WithModifiedIndent is a function that modifies the indentation level of the formatter by a specified amount relative to the current indentation level.

Parameters:

  • by: The amount by which to modify the indentation level.

Returns:

  • ConfigOption: The configuration option.

Behaviors:

  • Negative values will decrease the indentation level while positive values will increase it. If the value is 0, then nothing is done and when the indentation level is 0, it is not decreased.

func WithRightDelimiter 

func WithRightDelimiter(str string) ConfigOption

WithRightDelimiter is a function that modifies the right delimiter of the formatter.

Parameters:

  • str: The string to use as the right delimiter.

Returns:

  • ConfigOption: The configuration option.

Behaviors:

  • If str is empty, then the right delimiter is removed.

type DelimiterConfig 

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

DelimiterConfig is a type that represents the configuration for delimiters.

func NewDelimiterConfig 

func NewDelimiterConfig(str string, isInline, left bool) *DelimiterConfig

NewDelimiterConfig is a function that creates a new delimiter configuration.

Parameters:

  • value: The string that is used as a delimiter.
  • inline: Whether the delimiter should be inline.

Returns:

  • *DelimiterConfig: A pointer to the new delimiter configuration. Never returns nil.

Default values:

  • ==DelimiterConfig==
  • Value: ""
  • Inline: true

func (DelimiterConfig) Copy 

func (c DelimiterConfig) Copy() *DelimiterConfig

Copy is a method that creates a copy of the delimiter configuration.

Returns:

  • *DelimiterConfig: A copy of the delimiter configuration. Never returns nil.

type FStringFunc 

type FStringFunc[T any] func(trav *Traversor, elem T) error

FStringFunc is a function that generates a formatted string representation of an object.

Parameters:

  • trav: The traversor to use for printing.
  • elem: The element to print.

Returns:

  • error: An error if there was a problem generating the string.

type FStringer 

type FStringer interface {
	// FString returns a string representation of the object.
	//
	// Parameters:
	//   - trav: The traversor to use for printing.
	//   - opts: The options to use for printing.
	//
	// Returns:
	//   - error: An error if there was a problem generating the string.
	FString(trav *Traversor, opts ...Option) error
}

FStringer is an interface that defines the behavior of a type that can be converted to a string representation.

type FormatConfig 

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

FormatterConfig is a type that represents a configuration for the general formatter. 

var (
	// ArrayLikeFormat is the default options for an array-like object.
	// [1, 2, 3]
	ArrayLikeFormat *FormatConfig
)
var (
	// DefaultFormatter is the default formatter.
	//
	// ==IndentConfig==
	//   - DefaultIndentationConfig
	//
	// ==SeparatorConfig==
	//   - DefaultSeparatorConfig
	//
	// ==DelimiterConfig (Left and Right)==
	//   - Nil (no delimiters are used by default)
	DefaultFormatter *FormatConfig
)

func MergeForm 

func MergeForm(form1, form2 *FormatConfig) *FormatConfig

MergeForm is a function that merges the given formatter with the current one; prioritizing the values of the first formatter.

Parameters:

  • form1: The first formatter.
  • form2: The second formatter.

Returns:

  • *FormatConfig: A pointer to the new formatter.

func NewFormatter 

func NewFormatter(options ...any) *FormatConfig

NewFormatter is a function that creates a new formatter with the given configuration.

Parameters:

  • options: The configuration for the formatter.

Returns:

  • form: A pointer to the new formatter.

Behaviors:

  • The function panics if an invalid configuration type is given. (i.e., not IndentConfig, DelimiterConfig, or SeparatorConfig)
  • If no formatter configuration is given, the default formatter configuration is used.

func (FormatConfig) Copy 

func (form FormatConfig) Copy() *FormatConfig

Copy is a method that creates a copy of the formatter configuration.

Returns:

  • *FormatterConfig: A copy of the formatter configuration. Never returns nil.

func (FormatConfig) GetSpacingSize 

func (form FormatConfig) GetSpacingSize() int

GetIndentationSize is a function that returns the indentation size of the formatter.

Returns:

  • int: The indentation size.

func (FormatConfig) GetTabSize 

func (form FormatConfig) GetTabSize() int

GetTabSize is a function that returns the tab size of the formatter.

Returns:

  • int: The tab size.

type FormatterConfig 

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

FormatterConfig is a type that represents the configuration for formatting.

func NewFormatterConfig 

func NewFormatterConfig(tabSize, spacingSize int) *FormatterConfig

NewFormatterConfig is a function that creates a new formatter configuration.

Parameters:

  • tabSize: The size of the tab.
  • spacingSize: The size of the spacing.

Returns:

  • *FormatterConfig: A pointer to the new formatter configuration.

Default values: 

	==FormatterConfig==
  - TabSize: 3
  - SpacingSize: 1

Behaviors:

  • If tabSize is less than 1, it is set to 3.
  • If spacingSize is less than 1, it is set to 1.

func (FormatterConfig) Copy 

func (c FormatterConfig) Copy() *FormatterConfig

Copy is a method that creates a copy of the formatter configuration.

Returns:

  • *FormatterConfig: A copy of the formatter configuration. Never returns nil.

type IndentConfig 

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

IndentConfig is a type that represents the configuration for indentation.

func NewIndentConfig 

func NewIndentConfig(str string, initialLevel int) *IndentConfig

NewIndentConfig is a function that creates a new indentation configuration.

Parameters:

  • indentation: The string that is used for indentation.
  • initialLevel: The initial indentation level.

Returns:

  • *IndentConfig: A pointer to the new indentation configuration. Never returns nil.

Default values: 

	==IndentConfig==
  - Indentation: DefaultIndentation
  - InitialLevel: 0

Behaviors:

  • If initialLevel is negative, it is set to 0.
  • If indentation is empty, it is set to DefaultIndentation.

func (IndentConfig) Copy 

func (c IndentConfig) Copy() *IndentConfig

Copy is a method that creates a copy of the indentation configuration.

Returns:

  • *IndentConfig: A copy of the indentation configuration. Never returns nil.

func (IndentConfig) GetIndentStr 

func (c IndentConfig) GetIndentStr() string

GetIndentStr is a method that returns the indentation string.

Returns:

  • string: The indentation string.

func (IndentConfig) GetIndentation 

func (c IndentConfig) GetIndentation() string

GetIndentation is a method that returns the applied indentation.

Returns:

  • string: The applied indentation.

type Option 

type Option func(Settinger)

Option is a function that sets the settings for the formatting functions.

Parameters:

  • Settinger: The settings to set.

type SeparatorConfig 

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

SeparatorConfig is a type that represents the configuration for separators.

func NewSeparator 

func NewSeparator(sep string, includeFinal bool) *SeparatorConfig

NewSeparator is a function that creates a new separator configuration.

Parameters:

  • separator: The string that is used as a separator.
  • hasFinalSeparator: Whether the last element should have a separator.

Returns:

  • *SeparatorConfig: A pointer to the new separator configuration. Never returns nil.

Default values: 

	==SeparatorConfig==
  - Separator: DefaultSeparator
  - HasFinalSeparator: false

Behaviors:

  • If separator is empty, it is set to DefaultSeparator.

func (SeparatorConfig) Copy 

func (c SeparatorConfig) Copy() *SeparatorConfig

Copy is a method that creates a copy of the separator configuration.

Returns:

  • *SeparatorConfig: A copy of the separator configuration. Never returns nil.

type Settinger 

type Settinger interface{}

Settinger is an interface that represents the settings for the formatting functions.

type SimplePrinter 

type SimplePrinter[T comparable] struct {
	// contains filtered or unexported fields
}

SimplePrinter is a simple printer that prints a value with a name.

func NewSimplePrinter 

func NewSimplePrinter[T comparable](name string, value T, fn func(T) (string, error)) *SimplePrinter[T]

NewSimplePrinter creates a new SimplePrinter with the provided name and value.

Parameters:

  • name: The name of the value.
  • value: The value to print.
  • fn: The function to use to convert the value to a string.

Returns:

  • *SimplePrinter: The new SimplePrinter. Never returns nil.

Behaviors:

  • If the function is nil, the function uses lustr.GoStringOf to convert the value to a string.

func (SimplePrinter[T]) FString 

func (sp SimplePrinter[T]) FString(trav *Traversor) error

FString generates a formatted string representation of a SimplePrinter.

Format: 

<name>: <value>

Parameters:

  • trav: The traversor to use for printing.

Returns:

  • error: An error if the printing fails.

type StdPrinter 

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

StdPrinter is a type that represents a formatted string.

func (*StdPrinter) Clean 

func (p *StdPrinter) Clean()

Cleanup implements the Cleaner interface.

func (*StdPrinter) GetPages 

func (p *StdPrinter) GetPages() [][][][]string

GetPages returns the pages of the StdPrinter.

Returns:

  • [][][][]string: The pages of the StdPrinter. Nil if the receiver is nil.

type Traversor 

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

Traversor is a type that represents a traversor for a formatted string.

func (*Traversor) AcceptLine 

func (trav *Traversor) AcceptLine() bool

AcceptLine is a function that accepts the current line of the traversor.

Returns:

  • bool: True if the receiver is not nil, false otherwise.

Behaviors:

  • This also accepts the current word if any.

func (*Traversor) AcceptWord 

func (trav *Traversor) AcceptWord() bool

AcceptWord is a function that, if there is any in-progress word, then said word is added to the source.

Returns:

  • bool: True if the receiver is not nil, false otherwise.

func (*Traversor) AddJoinedLine 

func (trav *Traversor) AddJoinedLine(sep string, fields ...string) error

AddJoinedLine adds a joined line to the traversor. This is a more efficient way to do the same as AddLine(strings.Join(fields, sep)).

Parameters:

  • sep: The separator to use.
  • fields: The fields to join.

Returns:

  • error: An error if this function fails.

Error:

  • errors.NilReceiver if the receiver is nil.
  • *ints.ErrInvalidRuneAt if there is an invalid rune in the line.

Behaviors:

  • If fields is empty, then nothing is done.

func (*Traversor) AddLine 

func (trav *Traversor) AddLine(line string) error

AddLine adds a line to the traversor. If there is any in-progress line, then the line is appended to the line before accepting it. Otherwise, a new line with the line is added to the source.

Parameters:

  • line: The line to add.

Returns:

  • error: An error if this function fails.

Errors:

  • errors.NilReceiver if the receiver is nil.
  • *ints.ErrAt if there is an error adding the line.

Behaviors:

  • If line is empty, then an empty line is added to the source.

func (*Traversor) AddLines 

func (trav *Traversor) AddLines(lines []string) error

AddLines adds multiple lines to the traversor in a more efficient way than adding each line individually.

Parameters:

  • lines: The lines to add.

Returns:

  • error: An error if this function fails.

Errors:

  • errors.NilReceiver if the receiver is nil.
  • *ints.ErrAt if there is an error adding a line.

Behaviors:

  • If there are no lines, then nothing is done.

func (*Traversor) AppendJoinedString 

func (trav *Traversor) AppendJoinedString(sep string, fields ...string) error

AppendJoinedString appends a joined string to the half-line of the traversor.

Parameters:

  • sep: The separator to use.
  • fields: The fields to join.

Returns:

  • error: An error if this function fails.

Errors:

  • errors.NilReceiver if the receiver is nil.
  • *runes.ErrInvalidUTF8Encoding if some field or the separator is not valid UTF-8 encoding.

Behaviors:

  • This is equivalent to calling AppendString(strings.Join(fields, sep)).

func (*Traversor) AppendRune 

func (trav *Traversor) AppendRune(r rune) bool

AppendRune appends a rune to the half-line of the traversor.

Parameters:

  • r: The rune to append.

Returns:

  • bool: True if the receiver is not nil, false otherwise.

Behaviors:

  • If the half-line is nil, then a new half-line is created.

func (*Traversor) AppendString 

func (trav *Traversor) AppendString(str string) error

AppendString appends a string to the half-line of the traversor.

Parameters:

  • str: The string to append.

Returns:

  • error: An error if this function fails.

Errors:

  • errors.NilReceiver if the receiver is nil.
  • *runes.ErrInvalidUTF8Encoding if the string is not valid UTF-8.

Behaviors:

  • IF str is empty: nothing is done.

func (*Traversor) AppendStrings 

func (trav *Traversor) AppendStrings(strs []string) error

AppendStrings appends multiple strings to the half-line of the traversor.

Parameters:

  • strs: The strings to append.

Returns:

  • error: An error if this function fails.

Errors:

  • errors.NilReceiver if the receiver is nil.
  • *ints.ErrAt if there is an error appending a string.

Behaviors:

  • This is equivalent to calling AppendString for each string in strs but more efficient.

func (*Traversor) Clean 

func (trav *Traversor) Clean()

Cleanup implements the Cleaner interface.

func (*Traversor) EmptyLine 

func (trav *Traversor) EmptyLine() bool

EmptyLine adds an empty line to the traversor. This is a more efficient way to do the same as AddLine("") or AddLines([]string{""}).

Returns:

  • bool: True if the receiver is not nil, false otherwise.

Behaviors:

  • If the half-line is not empty, then the half-line is added to the source (half-line is reset) and an empty line is added to the source.

func (Traversor) GetConfig 

func (trav Traversor) GetConfig(options ...ConfigOption) (*FormatConfig, error)

GetConfig is a method that returns a copy of the configuration of the traversor.

Parameters:

  • options: The options to apply to the configuration.

Returns:

  • *FormatConfig: A pointer to the copy of the configuration of the traversor.
  • error: An error of type errors.NilReceiver if the receiver is nil.

func (*Traversor) Lock 

func (trav *Traversor) Lock() bool

Lock locks the traversor. Be aware of deadlocks.

Returns:

  • bool: True if the receiver is not nil, false otherwise.

func (*Traversor) Print 

func (trav *Traversor) Print(a ...interface{}) error

Print is a function that writes to the traversor using the fmt.Fprint function.

Parameters:

  • a: The arguments to write.

Returns:

  • error: An error if this function fails.

Error:

  • errors.NilReceiver if the receiver is nil.
  • any other error returned by the fmt.Fprint function.

func (*Traversor) Printf 

func (trav *Traversor) Printf(format string, a ...interface{}) error

Printf is a function that writes to the traversor using the fmt.Fprintf function.

Parameters:

  • format: The format string.
  • a: The arguments to write.

Returns:

  • error: An error if this function fails.

Error:

  • errors.NilReceiver if the receiver is nil.
  • any other error returned by the fmt.Fprintf function.

func (*Traversor) Println 

func (trav *Traversor) Println(a ...interface{}) error

Println is a function that writes to the traversor using the fmt.Fprintln function.

Parameters:

  • a: The arguments to write.

Returns:

  • error: An error if this function fails.

Error:

  • errors.NilReceiver if the receiver is nil.
  • any other error returned by the fmt.Fprintln function.

func (*Traversor) Unlock 

func (trav *Traversor) Unlock() bool

Unlock unlocks the traversor. Be aware of deadlocks.

Returns:

  • bool: True if the receiver is not nil, false otherwise.

func (*Traversor) Write 

func (trav *Traversor) Write(p []byte) (int, error)

Write implements the io.Writer interface for the traversor.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.