Struct burn_wgpu::kernel::SourceTemplate

pub struct SourceTemplate { /* private fields */ }

Kernel source code abstraction allowing for templating.

The templates can have text placeholders in the form {{ label }}. They will be updated with their proper value when generate is called.

Implementations

impl SourceTemplate

pub fn new<S>(template: S) -> Selfwhere S: Into<String>,

Create a new source template.

pub fn register<Name, Value>(self, name: Name, value: Value) -> Selfwhere Name: Into<String>, Value: Into<String>,

Register the value for a placeholder item.

Notes

The value can’t have placeholders, since it would require recursive templating with possibly circular dependencies. If you want to add a value that has some placeholders, consider adding a new template to the source using add_template. The added template can be a function, and you can register the function call instead.

pub fn add_template<S>(self, template: S) -> Selfwhere S: Into<String>,

Add a new template.

pub fn complete(self) -> String

Complete the template and returns the source code.

Trait Implementations

impl Debug for SourceTemplate

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

Formats the value using the given formatter.