Struct oso::ClassBuilder

pub struct ClassBuilder<T> { /* fields omitted */ }

Implementations

impl<T> ClassBuilder<T> where
    T: 'static, 

pub fn with_default() -> Self where
    T: Default,
    T: Send + Sync, 

Create a new class builder for a type that implements Default and use that as the constructor.

pub fn with_constructor<F, Args>(f: F) -> Self where
    F: Function<Args, Result = T>,
    T: Send + Sync,
    Args: FromPolarList, 

Create a new class builder with a given constructor.

pub fn set_constructor<F, Args>(self, f: F) -> Self where
    F: Function<Args, Result = T>,
    T: Send + Sync,
    Args: FromPolarList, 

Set the constructor function to use for polar new statements.

pub fn set_equality_check<F>(self, f: F) -> Self where
    F: Fn(&T, &T) -> bool + Send + Sync + 'static, 

Set an equality function to be used for polar == statements.

pub fn set_into_iter<F, I, V>(self, f: F) -> Self where
    F: Fn(&T) -> I + Send + Sync + 'static,
    I: Iterator<Item = V> + Clone + Send + Sync + 'static,
    V: ToPolarResult, 

Set a method to convert instances into iterators

pub fn with_iter<V>(self) -> Self where
    T: IntoIterator<Item = V> + Clone,
    <T as IntoIterator>::IntoIter: Clone + Send + Sync + 'static,
    V: ToPolarResult, 

Use the existing IntoIterator implementation to convert instances into iterators

pub fn with_equality_check(self) -> Self where
    T: PartialEq<T>, 

Use PartialEq::eq as the equality check for polar == statements.

pub fn add_attribute_getter<F, R>(self, name: &'static str, f: F) -> Self where
    F: Fn(&T) -> R + Send + Sync + 'static,
    R: ToPolar,
    T: 'static, 

Add an attribute getter for statments like foo.bar `class.add_attribute_getter(“bar”, |instance| instance.bar)

pub fn name(self, name: &str) -> Self

Set the name of the polar class.

pub fn add_constant<V: ToPolar + Clone + Send + Sync + 'static>(
    self,
    value: V,
    name: &'static str
) -> Self

Add a RegisterHook on the class that will register the given constant once the class is registered.

pub fn add_method<F, Args, R>(self, name: &'static str, f: F) -> Self where
    Args: FromPolarList,
    F: Method<T, Args, Result = R>,
    R: ToPolarResult + 'static, 

Add a method for polar method calls like foo.plus(1) class.add_attribute_getter(“bar”, |instance, n| instance.foo + n)

pub fn add_iterator_method<F, Args, I>(self, name: &'static str, f: F) -> Self where
    Args: FromPolarList,
    F: Method<T, Args>,
    F::Result: IntoIterator<Item = I>,
    I: ToPolarResult + 'static,
    <<F as Method<T, Args>>::Result as IntoIterator>::IntoIter: Iterator<Item = I> + Clone + Send + Sync + 'static,
    T: 'static, 

A method that returns multiple values. Every element in the iterator returned by the method will be a separate polar return value.

pub fn add_class_method<F, Args, R>(self, name: &'static str, f: F) -> Self where
    F: Function<Args, Result = R>,
    Args: FromPolarList,
    R: ToPolarResult + 'static, 

A method that’s called on the type instead of an instance. eg Foo.pi

pub fn build(self) -> Class

Finish building a build the class

Trait Implementations

impl<T: Clone> Clone for ClassBuilder<T>

fn clone(&self) -> ClassBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.