Struct Variables 

pub struct Variables { /* private fields */ }

Ordered set of channel variables with FreeSWITCH escaping.

Values containing commas are escaped with \,, single quotes with \', and values with spaces are wrapped in single quotes.

Serde format

Default scope serializes as a flat JSON map: {"key": "value", ...}. Non-default scopes serialize as {"scope": "Enterprise", "vars": {"key": "value"}}. Deserialization accepts both formats; a flat map implies Default scope.

Implementations

impl Variables

pub fn new(vars_type: VariablesType) -> Self

Create an empty variable set with the given scope.

pub fn with_vars( vars_type: VariablesType, vars: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>, ) -> Self

Create from an existing set of key-value pairs.

pub fn insert(&mut self, key: impl Into<String>, value: impl Into<String>)

Insert or overwrite a variable.

pub fn remove(&mut self, key: &str) -> Option<String>

Remove a variable by name, returning its value if it existed.

pub fn get(&self, key: &str) -> Option<&str>

Look up a variable by name.

pub fn is_empty(&self) -> bool

Whether the set contains no variables.

pub fn len(&self) -> usize

Number of variables.

pub fn scope(&self) -> VariablesType

Variable scope (Enterprise, Default, or Channel).

pub fn set_scope(&mut self, scope: VariablesType)

Change the variable scope.

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Iterate over key-value pairs in insertion order.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&str, &mut String)>

Mutable iterator over key-value pairs in insertion order.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut String>

Mutable iterator over values in insertion order.

Trait Implementations

impl Clone for Variables

fn clone(&self) -> Variables

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Variables

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Variables

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Variables

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

Formats the value using the given formatter.

impl FromStr for Variables

type Err = OriginateError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Variables

fn eq(&self, other: &Variables) -> 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 Serialize for Variables

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Variables

impl StructuralPartialEq for Variables