suddendeath

README

go-suddendeath ("突然の死" generator in Go)

go-suddendeath generates "突然の死" like message based on the given string.

＿人人人人人人＿
＞　突然の死　＜
￣Y^Y^Y^Y^Y￣

Usage

suddendeath package is the package to import for your own projects.

See sample files in _example directory for how to use.

Documentation

Index

• Variables
• func Body(msg string) string
• func Footer(msg string) string
• func Format(msg string) string
• func Header(msg string) string
• func MessageWidth(msg string) int
• func Print(msg string)
• func RuneWidth(r rune) int

Variables

var (
	HeaderRunes = []rune{'人'}
	FooterRunes = []rune{'Ｙ'}
	LeftChar    = "＞"
	RightChar   = "＜"
)

Functions

func Body

func Body(msg string) string

Body returns the message body part of "突然の死" like message. Body adds side ornament characters and spaces in each lines.

func Footer

func Footer(msg string) string

Footer returns the footer string of "突然の死" like message based on the display width of msg.

func Format

func Format(msg string) string

Format returns "突然の死"-nized version of msg.

func Header

func Header(msg string) string

Header returns the header string of "突然の死" like message based on the display width of msg.

func MessageWidth

func MessageWidth(msg string) int

MessageWidth is the display width of assined string msg. msg is expected to be single line; i.e. not including \r and \n. It is based on the information from Unicode. So-called Multibyte characters' width is counted as 2. Other characters' are 1. See https://godoc.org/golang.org/x/text/width for the details.

func Print

func Print(msg string)

Print simply prints the string using fmt.Println.

func RuneWidth

func RuneWidth(r rune) int

RuneWidth returns the display width of r.