Struct ext_php_rs::args::ArgParser

pub struct ArgParser<'a, 'b> { /* private fields */ }

Parses the arguments of a function.

Implementations

impl<'a, 'b> ArgParser<'a, 'b>

pub fn new(arg_zvals: Vec<Option<&'a mut Zval>>) -> Self

Builds a new function argument parser.

pub fn arg(self, arg: &'b mut Arg<'a>) -> Self

Adds a new argument to the parser.

Parameters

• arg - The argument to add to the parser.

pub fn not_required(self) -> Self

Sets the next arguments to be added as not required.

pub fn parse(self) -> Result<()>

Uses the argument parser to parse the arguments contained in the given ExecuteData object. Returns successfully if the arguments were parsed.

This function can only be safely called from within an exported PHP function.

Parameters

• execute_data - The execution data from the function.

Errors

Returns an Error type if there were too many or too little arguments passed to the function. The user has already been notified so you should break execution after seeing an error type.