Struct FnBuilder

pub struct FnBuilder<'a, P> { /* private fields */ }

A builder for functions.

Implementations

impl<'a, P: FnParent> FnBuilder<'a, P>

pub fn with_attr(self, attr: impl Into<String>) -> Self

Add an outer attribute

pub fn with_lifetime(self, name: impl Into<String>) -> Self

Add a lifetime parameter.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_lifetime("a") // fn foo<'a>()

pub fn as_async(self) -> Self

Make the function async

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .as_async() // async fn foo()

pub fn with_lifetime_deps<ITER, I>( self, name: impl Into<String>, dependencies: ITER, ) -> Self

where ITER: IntoIterator<Item = I>, I: Into<String>,

Add a lifetime parameter.

dependencies are the lifetime dependencies of the given lifetime.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_lifetime("a") // fn foo<'a>()
    .with_lifetime_deps("b", ["a"]) // fn foo<'b: 'a>()

pub fn with_generic(self, name: impl Into<String>) -> Self

Add a generic parameter. Keep in mind that will not work for lifetimes.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_generic("D") // fn foo<D>()

pub fn with_generic_deps<DEP, I>( self, name: impl Into<String>, dependencies: DEP, ) -> Self

where DEP: IntoIterator<Item = I>, I: Into<String>,

Add a generic parameter. Keep in mind that will not work for lifetimes.

dependencies are the dependencies of the parameter.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_generic("D") // fn foo<D>()
    .with_generic_deps("E", ["Encodable"]) // fn foo<D, E: Encodable>();

pub fn with_self_arg(self, self_arg: FnSelfArg) -> Self

Set the value for self. See FnSelfArg for more information.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_self_arg(FnSelfArg::RefSelf) // fn foo(&self)

pub fn with_arg(self, name: impl Into<String>, ty: impl Into<String>) -> Self

Add an argument with a name and a ty.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_arg("a", "u32") // fn foo(a: u32)
    .with_arg("b", "u32") // fn foo(a: u32, b: u32)

pub fn with_return_type(self, ret_type: impl Into<String>) -> Self

Set the return type for the function. By default the function will have no return type.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .with_return_type("u32") // fn foo() -> u32

pub fn make_pub(self) -> Self

Make the function pub. If this is not called, the function will have no visibility modifier.

pub fn body( self, body_builder: impl FnOnce(&mut StreamBuilder) -> Result, ) -> Result

Complete the function definition. This function takes a callback that will form the body of the function.

generator
    .r#impl()
    .generate_fn("foo") // fn foo()
    .body(|b| {
        b.push_parsed("println!(\"hello world\");")?;
        Ok(())
    })
    .unwrap();
// fn foo() {
//     println!("Hello world");
// }