Expand description
Test functions and abstractions.
Test functions in MiniJinja are like filters
but a
different syntax is used to invoke them and they have to return boolean
values. For instance the expression {% if foo is defined %}
invokes the
is_defined
test to check if the value is indeed an odd number.
MiniJinja comes with some built-in test functions that are listed below. To
create a custom test write a function that takes at least a value argument
that returns a boolean result, then register it with
add_filter
.
Using Tests
Tests are useful to “test” a value in a specific way. For instance if
you want to assign different classes to alternating rows one way is
using the odd
test:
{% if seq is defined %}
<ul>
{% for item in seq %}
<li class="{{ 'even' if loop.index is even else 'odd' }}">{{ item }}</li>
{% endfor %}
</ul>
{% endif %}
Custom Tests
A custom test function is just a simple function which accepts its inputs as parameters and then returns a bool. For instance the following shows a test function which takes an input value and checks if it’s lowercase:
fn is_lowercase(value: String) -> bool {
value.chars().all(|x| x.is_lowercase())
}
env.add_test("lowercase", is_lowercase);
MiniJinja will perform the necessary conversions automatically. For more
information see the Test
trait.
Built-in Tests
When the builtins
feature is enabled a range of built-in tests are
automatically added to the environment. These are also all provided in
this module. Note though that these functions are not to be
called from Rust code as their exact interface (arguments and return types)
might change from one MiniJinja version to another.
Traits
- A utility trait that represents test functions.
- A utility trait that represents the return value of filters.
Functions
- Checks if a value is defined.
- is_endingwith
builtins
Checks if the value is ending with a string. - is_eq
builtins
Test version of==
. - is_even
builtins
Checks if a value is even. - is_false
builtins
Checks if a value isfalse
. - is_filter
builtins
Checks if a filter with a given name is available. - is_ge
builtins
Test version of>=
. - is_gt
builtins
Test version of>
. - is_in
builtins
Test version ofin
. - is_le
builtins
Test version of<=
. - is_lt
builtins
Test version of<
. - is_mapping
builtins
Checks if this value is a mapping - is_ne
builtins
Test version of!=
. - Checks if a value is none.
- is_number
builtins
Checks if this value is a number. - is_odd
builtins
Checks if a value is odd. - Checks if a value is safe.
- is_sequence
builtins
Checks if this value is a sequence - is_startingwith
builtins
Checks if the value is starting with a string. - is_string
builtins
Checks if this value is a string. - is_test
builtins
Checks if a test with a given name is available. - is_true
builtins
Checks if a value istrue
. - Checks if a value is undefined.