Package: github.com/mattn/go-runewidth

package runewidth Import Path github.com/mattn/go-runewidth (on go.dev) Dependency Relation imports 4 packages, and imported by one package

Involved Source Files runewidth.go runewidth_posix.go runewidth_table.go

Package-Level Type Names (only one)

/* sort by: alphabet | popularity */

type Condition (struct) Condition have flag EastAsianWidth whether the current locale is CJK or not. Fields (total 2) EastAsianWidth bool StrictEmojiNeutral bool Methods (total 8) (*Condition) CreateLUT() CreateLUT will create an in-memory lookup table of 557056 bytes for faster operation. This should not be called concurrently with other operations on c. If options in c is changed, CreateLUT should be called again. (*Condition) FillLeft(s string, w int) string FillLeft return string filled in left by spaces in w cells (*Condition) FillRight(s string, w int) string FillRight return string filled in left by spaces in w cells (*Condition) RuneWidth(r rune) int RuneWidth returns the number of cells in r. See http://www.unicode.org/reports/tr11/ (*Condition) StringWidth(s string) (width int) StringWidth return width as you can see (*Condition) Truncate(s string, w int, tail string) string Truncate return string truncated with w cells (*Condition) TruncateLeft(s string, w int, prefix string) string TruncateLeft cuts w cells from the beginning of the `s`. (*Condition) Wrap(s string, w int) string Wrap return string wrapped with w cells As Outputs Of (at least one exported) func NewCondition() *Condition As Types Of (only one) var DefaultCondition *Condition

Package-Level Functions (total 12)

func CreateLUT() CreateLUT will create an in-memory lookup table of 557055 bytes for faster operation. This should not be called concurrently with other operations.

func FillLeft(s string, w int) string FillLeft return string filled in left by spaces in w cells

func FillRight(s string, w int) string FillRight return string filled in left by spaces in w cells

func IsAmbiguousWidth(r rune) bool IsAmbiguousWidth returns whether is ambiguous width or not.

func IsEastAsian() bool IsEastAsian return true if the current locale is CJK

func IsNeutralWidth(r rune) bool IsNeutralWidth returns whether is neutral width or not.

func NewCondition() *Condition NewCondition return new instance of Condition which is current locale.

func RuneWidth(r rune) int RuneWidth returns the number of cells in r. See http://www.unicode.org/reports/tr11/

func StringWidth(s string) (width int) StringWidth return width as you can see

func Truncate(s string, w int, tail string) string Truncate return string truncated with w cells

func TruncateLeft(s string, w int, prefix string) string TruncateLeft cuts w cells from the beginning of the `s`.

func Wrap(s string, w int) string Wrap return string wrapped with w cells

Package-Level Variables (total 3)

var DefaultCondition *Condition DefaultCondition is a condition in current locale

var EastAsianWidth bool EastAsianWidth will be set true if the current locale is CJK

var StrictEmojiNeutral bool StrictEmojiNeutral should be set false if handle broken fonts