<!-- Auto-generated — do not edit by hand -->
# Clojure String Audit for PTC-Lisp

> **Warning:** This file is auto-generated by `mix ptc.gen_docs` from `priv/function_audit.exs`.
> Manual edits will be overwritten. Edit `priv/function_audit.exs` instead.

Comparison of `clojure.string` vars against PTC-Lisp builtins.

See also: [Function Reference](../function-reference.md) | [Clojure Core Audit](clojure-core-audit.md) | [Clojure Set Audit](clojure-set-audit.md) | [Clojure Walk Audit](clojure-walk-audit.md) | [Java Math Audit](java-math-audit.md)

## Summary

| Status | Count |
|--------|-------|
| Supported | 16 |
| Candidate | 4 |
| Not Relevant | 1 |
| Not Classified | 0 |
| **Total** | **21** |

## Details

| Var | Status | Description | Notes |
|-----|--------|-------------|-------|
| `blank?` | ✅ supported | True if s is nil, empty, or contains only whitespace | Unicode whitespace (Elixir String.trim), not Java Character.isWhitespace; e.g. U+00A0 counts as blank here but not in Clojure |
| `capitalize` | 🔲 candidate | Converts first character to upper-case, rest to lower-case | pure string transformation |
| `ends-with?` | ✅ supported | True if s ends with substr |  |
| `escape` | 🔲 candidate | Return a new string applying cmap to each character | pure character mapping |
| `includes?` | ✅ supported | True if s includes substr |  |
| `index-of` | ✅ supported | Return index of value in string |  |
| `join` | ✅ supported | Returns a string of elements joined by separator |  |
| `last-index-of` | ✅ supported | Return last index of value in string |  |
| `lower-case` | ✅ supported | Converts string to all lower-case |  |
| `re-quote-replacement` | ❌ not_relevant | Escapes special characters in replacement string | Java regex-specific utility |
| `replace` | ✅ supported | Replaces all instances of match in s |  |
| `replace-first` | 🔲 candidate | Replaces first instance of match in s | pure string transformation |
| `reverse` | 🔲 candidate | Returns s with characters reversed | pure string transformation |
| `split` | ✅ supported | Splits string on regex or string |  |
| `split-lines` | ✅ supported | Splits string on \n or \r\n |  |
| `starts-with?` | ✅ supported | True if s starts with substr |  |
| `trim` | ✅ supported | Removes whitespace from both ends of string | Unicode whitespace (Elixir String.trim), not Java Character.isWhitespace; e.g. U+00A0 is trimmed here but not in Clojure |
| `trim-newline` | ✅ supported | Removes all trailing newline or return characters |  |
| `triml` | ✅ supported | Removes whitespace from the left side of string | Unicode whitespace (Elixir String.trim_leading), not Java Character.isWhitespace; e.g. U+00A0 is trimmed here but not in Clojure |
| `trimr` | ✅ supported | Removes whitespace from the right side of string | Unicode whitespace (Elixir String.trim_trailing), not Java Character.isWhitespace; e.g. U+00A0 is trimmed here but not in Clojure |
| `upper-case` | ✅ supported | Converts string to all upper-case |  |
