kasane

README

kasane

String overlay library for Go

Usage

base := ".......\n.......\n.......\n.......\n......."
s := "xxx\nyyy\nzzz"

out := kasane.OverlayString(base, s, 1, 3)
fmt.Println(out)

// Output:
// .......
// ...xxx.
// ...yyy.
// ...zzz.
// .......

License

MIT

Documentation

Index

• func OverlayString(base, s string, top, left int, opts ...Option) string
• type Option
  • func WithPadding(w int) Option

Examples

• OverlayString

Functions

func OverlayString

func OverlayString(base, s string, top, left int, opts ...Option) string

OverlayString returns a string with the s string overlaid on the base string.

Example

base := ".......\n.......\n.......\n.......\n......."
s := "xxx\nyyy\nzzz"

out := OverlayString(base, s, 1, 3)
fmt.Println(out)

Output:

.......
...xxx.
...yyy.
...zzz.
.......

Types

type Option

type Option func(*k)

func WithPadding

func WithPadding(w int) Option

WithPadding sets the padding width. Lines shorter than w are processed with spaces appended.