Pudu programming language
Menu
API reference

Std.Ui.Text.wrapped

1 declaration

fn

wrapped: &Std.Ui.Text.Face -> Str -> Int -> Result[Array[Str], Std.Ui.Text.TextError]

This is a callable function.

What it does

Text broken into lines no wider than a width.

Newlines always break. Words are separated by spaces and placed greedily;

the space where a line breaks is dropped. A word wider than the width is

broken between characters, and at least one character is placed per line

so a width narrower than one glyph still makes progress.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Result makes success and recoverable failure part of the function's type.

Back to Std.Ui.TextSearch related declarations