Struct rustdoc::json::JsonRenderer
source · [−]pub(crate) struct JsonRenderer<'tcx> {
tcx: TyCtxt<'tcx>,
index: Rc<RefCell<FxHashMap<Id, Item>>>,
out_path: PathBuf,
cache: Rc<Cache>,
}Fields
tcx: TyCtxt<'tcx>index: Rc<RefCell<FxHashMap<Id, Item>>>A mapping of IDs that contains all local items for this crate which gets output as a top level field of the JSON blob.
out_path: PathBufThe directory where the blob will be written to.
cache: Rc<Cache>Implementations
sourceimpl JsonRenderer<'_>
impl JsonRenderer<'_>
pub(super) fn convert_item(&self, item: Item) -> Option<Item>
fn convert_span(&self, span: Span) -> Option<Span>
fn convert_visibility(&self, v: Visibility) -> Visibility
sourceimpl<'tcx> JsonRenderer<'tcx>
impl<'tcx> JsonRenderer<'tcx>
fn sess(&self) -> &'tcx Session
fn get_trait_implementors(&mut self, id: DefId) -> Vec<Id>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
fn get_impls(&mut self, id: DefId) -> Vec<Id>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
fn get_trait_items(&mut self) -> Vec<(Id, Item)>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Trait Implementations
sourceimpl<'tcx> Clone for JsonRenderer<'tcx>
impl<'tcx> Clone for JsonRenderer<'tcx>
sourcefn clone(&self) -> JsonRenderer<'tcx>
fn clone(&self) -> JsonRenderer<'tcx>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx>
impl<'tcx> FormatRenderer<'tcx> for JsonRenderer<'tcx>
sourcefn item(&mut self, item: Item) -> Result<(), Error>
fn item(&mut self, item: Item) -> Result<(), Error>
Inserts an item into the index. This should be used rather than directly calling insert on the hashmap because certain items (traits and types) need to have their mappings for trait implementations filled out before they’re inserted.
sourcefn descr() -> &'static str
fn descr() -> &'static str
Gives a description of the renderer. Used for performance profiling.
sourceconst RUN_ON_MODULE: bool
const RUN_ON_MODULE: bool
Whether to call item recursivly for modules Read more
sourcefn init(
krate: Crate,
options: RenderOptions,
cache: Cache,
tcx: TyCtxt<'tcx>
) -> Result<(Self, Crate), Error>
fn init(
krate: Crate,
options: RenderOptions,
cache: Cache,
tcx: TyCtxt<'tcx>
) -> Result<(Self, Crate), Error>
Sets up any state required for the renderer. When this is called the cache has already been populated. Read more
sourcefn make_child_renderer(&self) -> Self
fn make_child_renderer(&self) -> Self
Make a new renderer to render a child of the item currently being rendered.
sourcefn mod_item_in(&mut self, _item: &Item) -> Result<(), Error>
fn mod_item_in(&mut self, _item: &Item) -> Result<(), Error>
Renders a module (should not handle recursing into children).
sourcefn after_krate(&mut self) -> Result<(), Error>
fn after_krate(&mut self) -> Result<(), Error>
Post processing hook for cleanup and dumping output to files.
fn cache(&self) -> &Cache
sourcefn mod_item_out(&mut self) -> Result<(), Error>
fn mod_item_out(&mut self) -> Result<(), Error>
Runs after recursively rendering all sub-items of a module.
Auto Trait Implementations
impl<'tcx> !RefUnwindSafe for JsonRenderer<'tcx>
impl<'tcx> !Send for JsonRenderer<'tcx>
impl<'tcx> !Sync for JsonRenderer<'tcx>
impl<'tcx> Unpin for JsonRenderer<'tcx>
impl<'tcx> !UnwindSafe for JsonRenderer<'tcx>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more
impl<'a, T> Captures<'a> for T where
T: ?Sized,
Layout
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.
Size: 48 bytes