Crate germinate[−][src]
Expand description
This crate provides a method of injecting variables from multiple external sources into a
template string. Sources can be anything as long as they implement the
Loader
trait which handles the
loading of the variables in a standard way.
Features
default
-["aws"]
aws
- Enable the AWS value sources
Sources
Built In
These are the currently implemented sources and their associated template keys
Source | Key | Feature | Description |
---|---|---|---|
AWS EC2 Instance Tags | awsec2tag | aws | Load the value of AWS EC2 Instance Tags by their key |
AWS EC2 Metadata Service | awsec2metadata | aws | Load a value from the AWS EC2 Metadata Service by it’s path |
AWS SSM Parameter | awsssm | aws | Load a value from the AWS SSM Parameter Store by it’s name. LIMITATION when running on an EC2 instance, the parameter must be in the same region as the instance |
Environment Variables | env | - | Load the value of an environment variable |
Example
let mut seed = Seed::new("Hi %env:NAME%!");
let output = seed.germinate().await?;
assert_eq!("Hi John!", output);
Custom Sources
You can also include your own sources using the
Seed::add_custom_loader
method. The only requirement is that the custom loader must implement the
Loader
trait
Example
let mut seed = Seed::new("Hi %name:name%");
// Add a custom loader for the name key. This is the loader that will be used whenever
// germinate finds %name:...% in the template string
seed.add_custom_loader("name".to_string(), Box::new(NameLoader {}));
let output = seed.germinate().await?;
assert_eq!("Hi John", output);
Structs
A Seed
is responsible for parsing the template string, loading the values, and optionally
making the replacements via the germinate method
Traits
A type implementing the Loader trait can be used to load a value from a store by it’s key