Home / Docs / Standard library / Prelude

replace

Release v0.4.0Edition 0.2 and later

A function of the prelude, in scope in every module. Edition 0.2 and later.

una
pub replace(t: Text, pattern: Text, by: Text) -> Text
  requires pattern.len > 0

t with every non-overlapping occurrence of pattern replaced by by, left to right (spec/22 §2).

Parameters

Returns

Text: t with every non-overlapping occurrence of pattern replaced by by, left to right.

Requires

Each condition under requires is an obligation at every call, which una check proves (spec/12 §3): it reports U5001 when the condition is refuted and U5002 when it is unknown (spec/12 §6), and una run, una test and una build refuse a package with an obligation that is not proved (spec/22 §2).

See also

split, contains_text

Cost

Time O(b + m + result) (ADR 0070), where:

Example

src/shop.unauna
module shop

--- A product title with its separator changed.
pub main() -> Unit
  uses @console: Console[print]
=
  @console.print("Crème brûlée - large - boxed".replace(pattern: " - ", by: ", "))

una run . prints:

Output
Crème brûlée, large, boxed

Specification

Generated from the standard modules of una v0.4.0 (docs/std/listing.json, which is not part of the specification). The specification governs: spec/14 §1.