diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-11-28 14:57:10 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-12-01 21:54:55 +0100 |
| commit | b4921706f03cc432ced38f071f2d7d4517275d98 (patch) | |
| tree | f79aed3cb3c2b0e6a51dd5a4d999ab669895627a | |
| parent | e60a7a4c24477cfadacb21926a4020b7bbf811e4 (diff) | |
| download | rust-b4921706f03cc432ced38f071f2d7d4517275d98.tar.gz rust-b4921706f03cc432ced38f071f2d7d4517275d98.zip | |
Rename `FormatRenderer::InfoType` into `ModuleData` and rename `FormatRenderer::make_child_renderer` into `save_module_data`
| -rw-r--r-- | src/librustdoc/formats/renderer.rs | 12 | ||||
| -rw-r--r-- | src/librustdoc/html/render/context.rs | 6 | ||||
| -rw-r--r-- | src/librustdoc/json/mod.rs | 8 |
3 files changed, 13 insertions, 13 deletions
diff --git a/src/librustdoc/formats/renderer.rs b/src/librustdoc/formats/renderer.rs index 8ae3cad74e3..582ef7d2c48 100644 --- a/src/librustdoc/formats/renderer.rs +++ b/src/librustdoc/formats/renderer.rs @@ -21,14 +21,14 @@ pub(crate) trait FormatRenderer<'tcx>: Sized { /// /// For each module, we go through their items by calling for each item: /// - /// 1. make_child_renderer + /// 1. save_module_data /// 2. item /// 3. set_back_info /// /// However,the `item` method might update information in `self` (for example if the child is /// a module). To prevent it to impact the other children of the current module, we need to /// reset the information between each call to `item` by using `set_back_info`. - type InfoType; + type ModuleData; /// Sets up any state required for the renderer. When this is called the cache has already been /// populated. @@ -46,13 +46,13 @@ pub(crate) trait FormatRenderer<'tcx>: Sized { /// In short it goes like this: /// /// ```ignore (not valid code) - /// let reset_data = type.make_child_renderer(); + /// let reset_data = type.save_module_data(); /// type.item(item)?; /// type.set_back_info(reset_data); /// ``` - fn make_child_renderer(&mut self) -> Self::InfoType; + fn save_module_data(&mut self) -> Self::ModuleData; /// Used to reset current module's information. - fn set_back_info(&mut self, info: Self::InfoType); + fn set_back_info(&mut self, info: Self::ModuleData); /// Renders a single non-module item. This means no recursive sub-item rendering is required. fn item(&mut self, item: clean::Item) -> Result<(), Error>; @@ -89,7 +89,7 @@ fn run_format_inner<'tcx, T: FormatRenderer<'tcx>>( unreachable!() }; for it in module.items { - let info = cx.make_child_renderer(); + let info = cx.save_module_data(); run_format_inner(cx, it, prof)?; cx.set_back_info(info); } diff --git a/src/librustdoc/html/render/context.rs b/src/librustdoc/html/render/context.rs index c2d0bc915b0..b1da39b6b95 100644 --- a/src/librustdoc/html/render/context.rs +++ b/src/librustdoc/html/render/context.rs @@ -454,7 +454,7 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> { } const RUN_ON_MODULE: bool = true; - type InfoType = ContextInfo; + type ModuleData = ContextInfo; fn init( krate: clean::Crate, @@ -594,14 +594,14 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> { Ok((cx, krate)) } - fn make_child_renderer(&mut self) -> Self::InfoType { + fn save_module_data(&mut self) -> Self::ModuleData { self.deref_id_map.borrow_mut().clear(); self.id_map.borrow_mut().clear(); self.types_with_notable_traits.borrow_mut().clear(); self.info } - fn set_back_info(&mut self, info: Self::InfoType) { + fn set_back_info(&mut self, info: Self::ModuleData) { self.info = info; } diff --git a/src/librustdoc/json/mod.rs b/src/librustdoc/json/mod.rs index dd190be892f..9efcf6b4983 100644 --- a/src/librustdoc/json/mod.rs +++ b/src/librustdoc/json/mod.rs @@ -137,7 +137,7 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> { } const RUN_ON_MODULE: bool = false; - type InfoType = (); + type ModuleData = (); fn init( krate: clean::Crate, @@ -162,11 +162,11 @@ impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx> { )) } - fn make_child_renderer(&mut self) -> Self::InfoType { - unreachable!("RUN_ON_MODULE = false should never call make_child_renderer") + fn save_module_data(&mut self) -> Self::ModuleData { + unreachable!("RUN_ON_MODULE = false should never call save_module_data") } - fn set_back_info(&mut self, _info: Self::InfoType) { + fn set_back_info(&mut self, _info: Self::ModuleData) { unreachable!("RUN_ON_MODULE = false should never call set_back_info") } |
