Struct ext_php_rs::args::Arg

pub struct Arg<'a> { /* private fields */ }

Represents an argument to a function.

Implementations

impl<'a> Arg<'a>

pub fn new<T: Into<String>>(name: T, _type: DataType) -> Self

Creates a new argument.

Parameters

• name - The name of the parameter.
• _type - The type of the parameter.

Examples found in repository

src/closure.rs (line 129)

    pub fn build() {
        if CLOSURE_META.has_ce() {
            panic!("Closure has already been built.");
        }

        let ce = ClassBuilder::new("RustClosure")
            .method(
                FunctionBuilder::new("__invoke", Self::invoke)
                    .not_required()
                    .arg(Arg::new("args", DataType::Mixed).is_variadic())
                    .returns(DataType::Mixed, false, true)
                    .build()
                    .expect("Failed to build `RustClosure` PHP class."),
                MethodFlags::Public,
            )
            .object_override::<Self>()
            .build()
            .expect("Failed to build `RustClosure` PHP class.");
        CLOSURE_META.set_ce(ce);
    }

pub fn as_ref(self) -> Self

Sets the argument as a reference.

pub fn is_variadic(self) -> Self

Sets the argument as variadic.

Examples found in repository

src/closure.rs (line 129)

    pub fn build() {
        if CLOSURE_META.has_ce() {
            panic!("Closure has already been built.");
        }

        let ce = ClassBuilder::new("RustClosure")
            .method(
                FunctionBuilder::new("__invoke", Self::invoke)
                    .not_required()
                    .arg(Arg::new("args", DataType::Mixed).is_variadic())
                    .returns(DataType::Mixed, false, true)
                    .build()
                    .expect("Failed to build `RustClosure` PHP class."),
                MethodFlags::Public,
            )
            .object_override::<Self>()
            .build()
            .expect("Failed to build `RustClosure` PHP class.");
        CLOSURE_META.set_ce(ce);
    }

pub fn allow_null(self) -> Self

Sets the argument as nullable.

pub fn default<T: Into<String>>(self, default: T) -> Self

Sets the default value for the argument.

pub fn consume<T>(self) -> Result<T, Self>where
    for<'b> T: FromZvalMut<'b>,

Attempts to consume the argument, converting the inner type into T. Upon success, the result is returned in a Result.

If the conversion fails (or the argument contains no value), the argument is returned in an Err variant.

As this function consumes, it cannot return a reference to the underlying zval.

pub fn val<T>(&'a mut self) -> Option<T>where
    T: FromZvalMut<'a>,

Attempts to retrieve the value of the argument. This will be None until the ArgParser is used to parse the arguments.

pub fn zval(&mut self) -> Option<&mut &'a mut Zval>

Attempts to return a reference to the arguments internal Zval.

Returns

• Some(&Zval) - The internal zval.
• None - The argument was empty.

pub fn try_call(&self, params: Vec<&dyn IntoZvalDyn>) -> Result<Zval>

Attempts to call the argument as a callable with a list of arguments to pass to the function. Note that a thrown exception inside the callable is not detectable, therefore you should check if the return value is valid rather than unwrapping. Returns a result containing the return value of the function, or an error.

You should not call this function directly, rather through the call_user_func macro.

Parameters

• params - A list of parameters to call the function with.

Trait Implementations

impl<'a> Debug for Arg<'a>

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

Formats the value using the given formatter.

impl From<Arg<'_>> for _zend_expected_type

fn from(arg: Arg<'_>) -> Self

Converts to this type from the input type.