Struct handlebars::Helper [−][src]
pub struct Helper<'reg, 'rc> { /* fields omitted */ }
Expand description
Render-time Helper data when using in a helper definition
Implementations
Returns all helper params, resolved within the context
Returns nth helper param, resolved within the context.
Example
To get the first param in {{my_helper abc}}
or {{my_helper 2}}
,
use h.param(0)
in helper definition.
Variable abc
is auto resolved in current context.
use handlebars::*;
fn my_helper(h: &Helper, rc: &mut RenderContext) -> Result<(), RenderError> {
let v = h.param(0).map(|v| v.value())
.ok_or(RenderError::new("param not found"));
// ..
Ok(())
}
Returns hash, resolved within the context
Return hash value of a given key, resolved within the context
Example
To get the first param in {{my_helper v=abc}}
or {{my_helper v=2}}
,
use h.hash_get("v")
in helper definition.
Variable abc
is auto resolved in current context.
use handlebars::*;
fn my_helper(h: &Helper, rc: &mut RenderContext) -> Result<(), RenderError> {
let v = h.hash_get("v").map(|v| v.value())
.ok_or(RenderError::new("param not found"));
// ..
Ok(())
}
Returns the default inner template if the helper is a block helper.
Typically you will render the template via: template.render(registry, render_context)
Returns if the helper is a block one {{#helper}}{{/helper}}
or not {{helper 123}}
Returns if the helper has either a block param or block param pair
Returns block param if any