Struct EnumBuilder 

pub struct EnumBuilder { /* private fields */ }

Available on crate feature enum only.

A builder for PHP enums.

Implementations

impl EnumBuilder

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

Creates a new enum builder with the given name.

pub fn case(self, case: &'static EnumCase) -> Self

Adds an enum case to the enum.

Panics

If the case’s data type does not match the enum’s data type

pub fn method( self, method: FunctionBuilder<'static>, flags: MethodFlags, ) -> Self

Adds a method to the enum.

pub fn registration( self, register: fn(&'static mut ClassEntry, ArgInfoTables), ) -> Self

Function to register the enum with PHP, called once it is built.

See ClassBuilder::registration for the ownership contract of the argument info tables.

Parameters

• register - The function to call to register the enum.

pub fn docs(self, docs: DocComments) -> Self

Add documentation comments to the enum.

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

Registers the enum with PHP.

Panics

• If called outside a module startup (MINIT) function.
• If the registration function was not set prior to calling this method.

Errors

• Error::DuplicateMethod or Error::DuplicateConstant - If two methods or cases share a PHP name.
• Error::DuplicateClass - If a class with this name, ignoring ASCII case, is already registered.
• If the enum could not be registered, e.g. due to an invalid name or data type.

Trait Implementations

impl From<EnumBuilder> for Enum

fn from(val: EnumBuilder) -> Self

Converts to this type from the input type.