cc.strings

Various utilities for working with strings and text.

See also

• textutils For additional string related utilities.

Changes

• New in version 1.95.0

wrap(text [, width])Source

Wraps a block of text, so that each line fits within the given width.

This may be useful if you want to wrap text before displaying it to a monitor or printer without using print.

Parameters

1. text string The string to wrap.
2. width? number The width to constrain to, defaults to the width of the terminal.

Returns

1. { string... } The wrapped input string as a list of lines.

Usage

• Wrap a string and write it to the terminal.

  term.clear()
  local lines = require "cc.strings".wrap("This is a long piece of text", 10)
  for i = 1, #lines do
    term.setCursorPos(1, i)
    term.write(lines[i])
  end

ensure_width(line [, width])Source

Makes the input string a fixed width. This either truncates it, or pads it with spaces.

Parameters

1. line string The string to normalise.
2. width? number The width to constrain to, defaults to the width of the terminal.

Returns

1. string The string with a specific width.

Usage

• require "cc.strings".ensure_width("a short string", 20)

• require "cc.strings".ensure_width("a rather long string which is truncated", 20)

split(str, deliminator [, plain=false [, limit]])Source

Split a string into parts, each separated by a deliminator.

For instance, splitting the string "a b c" with the deliminator " ", would return a table with three strings: "a", "b", and "c".

By default, the deliminator is given as a Lua pattern. Passing true to the plain argument will cause the deliminator to be treated as a litteral string.

Parameters

1. str string The string to split.
2. deliminator string The pattern to split this string on.
3. plain? boolean = false Treat the deliminator as a plain string, rather than a pattern.
4. limit? number The maximum number of elements in the returned list.

Returns

1. { string... } The list of split strings.

Usage

• Split a string into words.

  require "cc.strings".split("This is a sentence.", "%s+")

• Split a string by "-" into at most 3 elements.

  require "cc.strings".split("a-separated-string-of-sorts", "-", true, 3)

See also

• table.concat To join strings together.

Changes

• New in version 1.112.0