Struct TemplateVariable 

pub struct TemplateVariable {
    pub name: String,
    pub description: String,
    pub required: bool,
    pub source: i32,
    pub default_value: String,
    pub pii: bool,
}

A variable placeholder within a template that gets substituted during rendering.

Fields

name: String

Variable name used in the template body (e.g. “employee_name”). Constraints: Max length 100 characters.

description: String

Human-readable description of what this variable represents. Constraints: Max length 500 characters.

required: bool

Whether this variable must be provided during rendering.

source: i32

Where this variable’s value comes from (profile attribute or campaign config).

default_value: String

Fallback value used when the source does not provide a value. Constraints: Max length 1000 characters.

pii: bool

When true, this variable’s rendered value is masked in session replay and heatmap screenshots. Org admin controls per variable.

Implementations

impl TemplateVariable

pub fn source(&self) -> TemplateVariableSource

Returns the enum value of source, or the default if the field is set to an invalid enum value.

pub fn set_source(&mut self, value: TemplateVariableSource)

Sets source to the provided enum value.

Trait Implementations

impl Clone for TemplateVariable

fn clone(&self) -> TemplateVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateVariable

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

Formats the value using the given formatter.

impl Default for TemplateVariable

fn default() -> Self

Returns the “default value” for a type.

impl Hash for TemplateVariable

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for TemplateVariable

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TemplateVariable

fn eq(&self, other: &TemplateVariable) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TemplateVariable

impl StructuralPartialEq for TemplateVariable