Struct TemplateOutput 

#[non_exhaustive]
pub struct TemplateOutput {
    pub template_position: usize,
    pub overall_position: usize,
    pub rendered_range: Range<usize>,
}

Rich output for a single template section.

This captures the exact string produced for one template section during formatting, along with both its template-only and overall section positions.

The output itself is represented as a byte range into RichFormatResult::rendered, which avoids retaining a second owned string for every template section collected through the rich rendering path.

Examples

use string_pipeline::Template;

let template = Template::parse("A: {upper} B: {lower}").unwrap();
let result = template.format_rich("MiXeD").unwrap();

assert_eq!(result.template_outputs()[0].template_position(), 0);
assert_eq!(result.template_outputs()[0].overall_position(), 1);
assert_eq!(result.template_output(0), Some("MIXED"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

template_position: usize

Position among template sections only.

overall_position: usize

Position among all sections, including literals.

rendered_range: Range<usize>

Byte range within RichFormatResult::rendered for this template section.

Implementations

impl TemplateOutput

pub fn template_position(&self) -> usize

Position among template sections only.

pub fn overall_position(&self) -> usize

Position among all sections, including literals.

pub fn rendered_range(&self) -> Range<usize>

Byte range within RichFormatResult::rendered for this template section.

pub fn as_str<'a>(&self, rendered: &'a str) -> &'a str

Borrow this section’s rendered output from the full rendered string.

This is the zero-allocation way to inspect a single template section once you have a RichFormatResult.

Trait Implementations

impl Clone for TemplateOutput

fn clone(&self) -> TemplateOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TemplateOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for TemplateOutput

fn eq(&self, other: &TemplateOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TemplateOutput

impl StructuralPartialEq for TemplateOutput