Struct ExecuteOn 

pub struct ExecuteOn { /* private fields */ }

An application for an execute_on_* hook such as ChannelVariable::ExecuteOnOriginate.

The switch splits the value at the first space or lone colon, expands what follows and runs the application on the channel; a name opening perl in any case, or one carrying ::, is queued on the session instead of run where the hook fires. Only a name and argument the application receives as written are representable. Set as execute_on_originate in an originate’s block, the hook runs on the new channel before that channel’s session thread starts, so a variable it sets is on the channel before a SIP leg builds its INVITE. That is how a large or free-text value reaches a leg without crossing the dial string’s tokenizer: the block carries paths, and the application reads the value from where they point. Not on a loopback leg, which the hook wedges in CS_INIT. docs/dial-string-format.md has the measurements and the traps.

Implementations

impl ExecuteOn

pub fn new( app: impl Into<String>, arg: Option<impl Into<String>>, ) -> Result<Self, OriginateError>

Refuses a name or argument the switch cuts, expands or reads as a block of scope variables, and a line break the wire cannot carry.

pub fn lua( script: impl AsRef<str>, args: impl IntoIterator<Item = impl AsRef<str>>, ) -> Result<Self, OriginateError>

lua <script> <args…>. mod_lua splits its argument on spaces, so a script path or argument carrying one is refused.

pub fn app(&self) -> &str

The application name.

pub fn arg(&self) -> Option<&str>

The argument, as the application receives it.

Trait Implementations

impl Clone for ExecuteOn

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteOn

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

Formats the value using the given formatter.

impl Display for ExecuteOn

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

Formats the value using the given formatter.

impl Eq for ExecuteOn

impl PartialEq for ExecuteOn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExecuteOn