Struct virtue::generate::Generator

pub struct Generator { /* fields omitted */ }

The generator is used to generate code.

Often you will want to use impl_for to generate an impl <trait_name> for <target_name()>.

Implementations

impl Generator

pub fn target_name(&self) -> &Ident

Return the name for the struct or enum that this is going to be implemented on.

pub fn impl(&mut self) -> Impl<'_>

Generate an impl <target_name> implementation. See Impl for more information.

pub fn generate_impl(&mut self) -> Impl<'_>

Generate an impl <target_name> implementation. See Impl for more information.

Alias for impl which doesn’t need a r# prefix.

pub fn impl_for<'a>(&'a mut self, trait_name: &str) -> Result<ImplFor<'a>>

Generate an for <trait_name> for <target_name> implementation. See ImplFor for more information.

pub fn impl_for_with_lifetimes<'a>(
    &'a mut self,
    trait_name: &str,
    lifetimes: &[&str]
) -> Result<ImplFor<'a>>

Generate an for <..lifetimes> <trait_name> for <target_name> implementation. See ImplFor for more information.

Note:

• Lifetimes should not have the leading apostrophe.
• The lifetimes passed to this function will automatically depend on any other lifetime this struct or enum may have. Example:
  • The struct is struct Foo<'a> {}
  • You call `generator.impl_for_with_lifetime(“Bar”, &[“b”])
  • The code will be impl<'a, 'b: 'a> Bar<'b> for Foo<'a> {}
• trait_name should not have custom lifetimes. These will be added automatically.

generator.impl_for_with_lifetimes("Foo", &["a", "b"]);

// will output:
// impl<'a, 'b> Foo<'a, 'b> for StructOrEnum { }

pub fn finish(self) -> Result<TokenStream>

Consume the contents of this generator. This must be called, or else the generator will panic on drop.

Trait Implementations

impl Drop for Generator

fn drop(&mut self)

Executes the destructor for this type.