Struct RenderOptions 

pub struct RenderOptions {
    pub field_overrides: HashMap<String, TemplateField>,
    pub context: RenderContext,
}

Fields

field_overrides: HashMap<String, TemplateField>

context: RenderContext

Implementations

impl RenderOptions

pub fn new( field_overrides: HashMap<String, TemplateField>, context: RenderContext, ) -> Self

Constructs a new RenderOptions.

impl RenderOptions

pub fn with_field_overrides(self, value: HashMap<String, TemplateField>) -> Self

Sets the field_overrides field of this struct.

Examples found in repository

examples/template_rendering_with_options.rs (line 46)

fn main() -> Result<(), Box<dyn Error>> {
    let input = r#"#VRML_SIM R2025a utf8

PROTO ContextAwareBox [
  field SFInt32 count 2
  field SFString label "default-label"
]
{
  Group {
    children [
      WorldInfo { title "%<= fields.label.value >%|%<= fields.label.defaultValue >%|%<= context.os >%" }
      %< for (let i = 0; i < fields.count.value; ++i) { >%
        Transform {
          translation %<= i >% 0 0
          children [ Box { size 0.5 0.5 0.5 } ]
        }
      %< } >%
    ]
  }
}
"#;

    let document: Proto = input.parse()?;

    let mut field_overrides = HashMap::new();
    field_overrides.insert("count".to_string(), TemplateField::SFInt32(3));
    field_overrides.insert(
        "label".to_string(),
        TemplateField::SFString("override-label".to_string()),
    );

    let context = RenderContext::default()
        .with_os("linux")
        .with_world("/workspace/worlds/example.wbt")
        .with_webots_version(RenderWebotsVersion::new(
            "R2025a".to_string(),
            "0".to_string(),
        ));

    let options = RenderOptions::default()
        .with_field_overrides(field_overrides)
        .with_context(context);

    let rendered = webots_proto_template::render(&document, &options)?;
    println!("{rendered}");

    Ok(())
}

pub fn with_context(self, value: RenderContext) -> Self

Sets the context field of this struct.

Examples found in repository

examples/template_rendering_with_options.rs (line 47)

fn main() -> Result<(), Box<dyn Error>> {
    let input = r#"#VRML_SIM R2025a utf8

PROTO ContextAwareBox [
  field SFInt32 count 2
  field SFString label "default-label"
]
{
  Group {
    children [
      WorldInfo { title "%<= fields.label.value >%|%<= fields.label.defaultValue >%|%<= context.os >%" }
      %< for (let i = 0; i < fields.count.value; ++i) { >%
        Transform {
          translation %<= i >% 0 0
          children [ Box { size 0.5 0.5 0.5 } ]
        }
      %< } >%
    ]
  }
}
"#;

    let document: Proto = input.parse()?;

    let mut field_overrides = HashMap::new();
    field_overrides.insert("count".to_string(), TemplateField::SFInt32(3));
    field_overrides.insert(
        "label".to_string(),
        TemplateField::SFString("override-label".to_string()),
    );

    let context = RenderContext::default()
        .with_os("linux")
        .with_world("/workspace/worlds/example.wbt")
        .with_webots_version(RenderWebotsVersion::new(
            "R2025a".to_string(),
            "0".to_string(),
        ));

    let options = RenderOptions::default()
        .with_field_overrides(field_overrides)
        .with_context(context);

    let rendered = webots_proto_template::render(&document, &options)?;
    println!("{rendered}");

    Ok(())
}

impl RenderOptions

pub fn with_field_overrides_from<I, K, V>(self, overrides: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<TemplateField>,

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.