runewidth

README

A package for counting runes

Rearranged from this package.

Documentation

Index

• Variables
• func FillLeft(s string, w int) string
• func FillRight(s string, w int) string
• func IsAmbiguousWidth(r rune) bool
• func IsNeutralWidth(r rune) bool
• func RuneWidth(r rune) int
• func StringWidth(s string) (width int)
• func Truncate(s string, w int, tail string) string
• func Wrap(s string, w int) string
• type Condition
  • func NewCondition(zeroWidthJoiner bool) *Condition
  • func (c *Condition) FillLeft(s string, w int) string
  • func (c *Condition) FillRight(s string, w int) string
  • func (c *Condition) RuneWidth(r rune) int
  • func (c *Condition) StringWidth(s string) (width int)
  • func (c *Condition) Truncate(s string, w int, tail string) string
  • func (c *Condition) Wrap(s string, w int) string

Variables

var (
	DefaultCondition = &Condition{ZeroWidthJoiner: true} // DefaultCondition is a condition in current locale

)

Functions

func FillLeft

func FillLeft(s string, w int) string

FillLeft return string filled in left by spaces in w cells

func FillRight

func FillRight(s string, w int) string

FillRight return string filled in left by spaces in w cells

func IsAmbiguousWidth

func IsAmbiguousWidth(r rune) bool

IsAmbiguousWidth returns whether is ambiguous width or not.

func IsNeutralWidth

func IsNeutralWidth(r rune) bool

IsNeutralWidth returns whether is neutral width or not.

func RuneWidth

func RuneWidth(r rune) int

RuneWidth returns the number of cells in r. See http://www.unicode.org/reports/tr11/

func StringWidth

func StringWidth(s string) (width int)

StringWidth return width as you can see

func Truncate

func Truncate(s string, w int, tail string) string

Truncate return string truncated with w cells

func Wrap

func Wrap(s string, w int) string

Wrap return string wrapped with w cells

Types

type Condition

type Condition struct {
	ZeroWidthJoiner bool
}

func NewCondition

func NewCondition(zeroWidthJoiner bool) *Condition

NewCondition return new instance of Condition which is current locale.

func (*Condition) FillLeft

func (c *Condition) FillLeft(s string, w int) string

FillLeft return string filled in left by spaces in w cells

func (*Condition) FillRight

func (c *Condition) FillRight(s string, w int) string

FillRight return string filled in left by spaces in w cells

func (*Condition) RuneWidth

func (c *Condition) RuneWidth(r rune) int

RuneWidth returns the number of cells in r - see http://www.unicode.org/reports/tr11/

func (*Condition) StringWidth

func (c *Condition) StringWidth(s string) (width int)

StringWidth return width as you can see

func (*Condition) Truncate

func (c *Condition) Truncate(s string, w int, tail string) string

Truncate return string truncated with w cells

func (*Condition) Wrap

func (c *Condition) Wrap(s string, w int) string

Wrap return string wrapped with w cells