This repository has been archived on 2026-10-29. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
Epiphany/vendor/codex/codex-rs/utils/template/README.md

41 lines
941 B
Markdown
Raw Normal View History

# codex-utils-template
Small, strict string templating for prompt and text assets.
Supported syntax:
- `{{ name }}` placeholder interpolation
- `{{{{` for a literal `{{`
- `}}}}` for a literal `}}`
The library is intentionally strict:
- parsing fails on malformed placeholders
- rendering fails on missing values
- rendering fails on duplicate values
- rendering fails on extra values not used by the template
## Example
```rust
use codex_utils_template::Template;
use codex_utils_template::render;
let template = Template::parse(
"Hello, {{ name }}.\nLiteral braces: {{{{ and }}}}.\nMode: {{ mode }}",
)?;
let rendered = template.render([
("name", "Codex"),
("mode", "strict"),
])?;
assert_eq!(
rendered,
"Hello, Codex.\nLiteral braces: {{ and }}.\nMode: strict"
);
let one_shot = render("Hi {{ who }}!", [("who", "there")])?;
assert_eq!(one_shot, "Hi there!");
# Ok::<(), Box<dyn std::error::Error>>(())
```