1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
use std::fmt::{self, Write};
use crate::bound::Bound;
use crate::field::Field;
use crate::formatter::{fmt_bounds, fmt_generics, Formatter};
use crate::function::Function;
use crate::r#type::Type;
/// Defines an impl block.
#[derive(Debug, Clone)]
pub struct Impl {
/// The struct being implemented.
target: Type,
/// Impl level generics.
generics: Vec<String>,
/// If implementing a trait.
impl_trait: Option<Type>,
/// Associated types.
assoc_tys: Vec<Field>,
/// The bounds of the impl block.
bounds: Vec<Bound>,
/// The functions for the impl block.
fns: Vec<Function>,
/// The macros for the impl block.
macros: Vec<String>,
}
impl Impl {
/// Returns a new impl definition.
///
/// # Arguments
///
/// * `target` - The impl's target.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let foo_impl = Impl::new("Foo");
/// ```
pub fn new<T>(target: T) -> Self
where
T: Into<Type>,
{
Impl {
target: target.into(),
generics: vec![],
impl_trait: None,
assoc_tys: vec![],
bounds: vec![],
fns: vec![],
macros: vec![],
}
}
/// Add a generic to the impl block.
///
/// This adds the generic for the block (`impl<T>`) and not the target
/// type.
///
/// # Arguments
///
/// * `name` - The name of the generic.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.generic("T");
/// ```
pub fn generic(&mut self, name: &str) -> &mut Self {
self.generics.push(name.to_string());
self
}
/// Add a generic to the target type.
///
/// # Arguments
///
/// * `ty` - The generic type to add to the target.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.target_generic("T");
/// ```
pub fn target_generic<T>(&mut self, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.target.generic(ty);
self
}
/// Set the trait that the impl block is implementing.
///
/// # Arguments
///
/// * `ty` - The trait that the impl block is implementing.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.impl_trait("T");
/// ```
pub fn impl_trait<T>(&mut self, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.impl_trait = Some(ty.into());
self
}
/// Add a macro to the impl block (e.g. `"#[async_trait]"`)
///
/// # Arguments
///
/// * `macro` - The macro to add.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.r#macro("async_trait");
/// ```
pub fn r#macro(&mut self, r#macro: &str) -> &mut Self {
self.macros.push(r#macro.to_string());
self
}
/// Set an associated type.
///
/// # Arguments
///
/// * `name` - The name of the associated type.
/// * `ty` - The type of the associated type.
///
/// # Examples
///
/// ```
/// use rust_codegen::*;
///
/// let mut scope = Scope::new();
///
/// let trait_foo = scope.new_trait("Foo");
/// let mut impl_bar = Impl::new("Bar");
///
/// impl_bar.associate_type("A", "Foo");
/// ```
pub fn associate_type<T>(&mut self, name: &str, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.assoc_tys.push(Field {
name: name.to_string(),
ty: ty.into(),
documentation: Vec::new(),
annotation: Vec::new(),
});
self
}
/// Add a `where` bound to the impl block.
///
/// # Arguments
///
/// * `name` - The name of the bound.
/// * `ty` - The type of the bound.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.bound("T", "Default");
pub fn bound<T>(&mut self, name: &str, ty: T) -> &mut Self
where
T: Into<Type>,
{
self.bounds.push(Bound {
name: name.to_string(),
bound: vec![ty.into()],
});
self
}
/// Push a new function definition, returning a mutable reference to it.
///
/// # Arguments
///
/// * `name` - The name of the function.
///
/// # Examples
///
/// ```
/// use rust_codegen::Impl;
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.new_fn("bar_fn");
pub fn new_fn(&mut self, name: &str) -> &mut Function {
self.push_fn(Function::new(name));
self.fns.last_mut().unwrap()
}
/// Push a function definition.
///
/// # Arguments
///
/// * `item` - The function definition to push.
///
/// # Examples
///
/// ```
/// use rust_codegen::{Function,Impl};
///
/// let mut foo_impl = Impl::new("Foo");
/// let bar_fn = Function::new("bar");
///
/// foo_impl.push_fn(bar_fn);
pub fn push_fn(&mut self, item: Function) -> &mut Self {
self.fns.push(item);
self
}
/// Formats the impl block using the given formatter.
///
/// # Arguments
///
/// * `fmt` - The formatter to use.
///
/// # Examples
///
/// ```
/// use rust_codegen::*;
///
/// let mut dest = String::new();
/// let mut fmt = Formatter::new(&mut dest);
///
/// let mut foo_impl = Impl::new("Foo");
/// foo_impl.fmt( &mut fmt);
/// ```
pub fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result {
for m in self.macros.iter() {
write!(fmt, "{}\n", m)?;
}
write!(fmt, "impl")?;
fmt_generics(&self.generics[..], fmt)?;
if let Some(ref t) = self.impl_trait {
write!(fmt, " ")?;
t.fmt(fmt)?;
write!(fmt, " for")?;
}
write!(fmt, " ")?;
self.target.fmt(fmt)?;
fmt_bounds(&self.bounds, fmt)?;
fmt.block(|fmt| {
// format associated types
if !self.assoc_tys.is_empty() {
for ty in &self.assoc_tys {
write!(fmt, "type {} = ", ty.name)?;
ty.ty.fmt(fmt)?;
write!(fmt, ";\n")?;
}
}
for (i, func) in self.fns.iter().enumerate() {
if i != 0 || !self.assoc_tys.is_empty() {
write!(fmt, "\n")?;
}
func.fmt(false, fmt)?;
}
Ok(())
})
}
}