Struct SetVariablesRequest 

pub struct SetVariablesRequest<T: SetVariablesRequestState> { /* private fields */ }

Request to update variables for a particular scope

Variable Scoping

Variables can be set either locally or hierarchically:

• Local: Variables only visible in specified scope
• Hierarchical: Variables propagate up to parent scopes

Examples

Two scopes with variables:

• Scope 1: { "foo": 2 }
• Scope 2: { "bar": 1 }

Setting { "foo": 5 } in scope 2:

• Local=true: Scope 2 becomes { "bar": 1, "foo": 5 }, Scope 1 unchanged
• Local=false: Scope 1 becomes { "foo": 5 }, Scope 2 unchanged

#[derive(Serialize)]
struct Foo {
    bar: String
}

client
    .set_variables()
    .with_element_instance_key(123456)
    .with_variable(Foo {bar: String::from("foobar")})
    .send()
    .await?;

Implementations

impl SetVariablesRequest<Initial>

pub fn with_element_instance_key( self, element_instance_key: i64, ) -> SetVariablesRequest<WithInstanceKey>

Sets the element instance key identifying the scope

Arguments

• element_instance_key - Key of element instance to update variables for

Returns

A SetVariablesRequest in the WithInstanceKey state

impl SetVariablesRequest<WithInstanceKey>

pub fn with_variable<T: Serialize>( self, data: T, ) -> Result<SetVariablesRequest<WithVariables>, ClientError>

Sets the variables to update in the scope

Arguments

• data - Variables as serializable type that will be converted to JSON

Errors

Returns ClientError if serialization fails

Returns

A SetVariablesRequest in the WithVariables state

impl SetVariablesRequest<WithVariables>

pub async fn send(self) -> Result<SetVariablesResponse, ClientError>

Sends the set variables request to the gateway

Returns

Response containing the unique key for this operation

Errors

• NOT_FOUND: No element exists with given key
• ClientError: If the request fails

pub fn with_operation_reference(self, operation_reference: u64) -> Self

Sets a reference ID to correlate this operation with other events

Arguments

• operation_reference - Unique identifier for correlation

Returns

The updated SetVariablesRequest with the operation reference set

pub fn set_local_scope(self, is_local_scope: bool) -> Self

Controls variable scope visibility

Arguments

• is_local_scope - If true, variables only visible in target scope If false, variables propagate up to parent scopes

Returns

The updated SetVariablesRequest with the local scope flag set

Trait Implementations

impl<T: Clone + SetVariablesRequestState> Clone for SetVariablesRequest<T>

fn clone(&self) -> SetVariablesRequest<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + SetVariablesRequestState> Debug for SetVariablesRequest<T>

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

Formats the value using the given formatter.