pub struct InboundIndex { /* private fields */ }Expand description
Repository-wide backlink index for server mode.
The server used to answer every links.json request by walking the entire
repository and grepping each markdown file for references to that one page
(link_grep::find_inbound_links). That is O(repository) per page, and the
info panel’s mini graph requests many pages at once, so a large repo paid
for a full walk per distinct page on every cache miss.
This inverts the relationship once instead: each markdown file is parsed a
single time, its internal outbound links are resolved to absolute URLs, and
each one is recorded as a backlink on its target. Lookups are then a hash
hit. It is the same inversion build::Builder::write_link_files performs
for static output, which also closes the long-standing server/build
disagreement about which links produce backlinks — the grep matched on path
spelling, while both inverted indexes use the renderer’s own resolution.
contributions is what makes incremental maintenance cheap: it remembers
which targets a given source page currently contributes to, so a changed
file’s old backlinks can be withdrawn without touching any other bucket.
Implementations§
Source§impl InboundIndex
impl InboundIndex
pub fn new() -> Self
Sourcepub fn mark_ready(&self)
pub fn mark_ready(&self)
Mark the index queryable. Called after the initial pass.
Sourcepub async fn wait_until_ready(&self)
pub async fn wait_until_ready(&self)
Wait until the initial full-repository pass has finished.
notify_waiters() stores no permit, so interest is registered before
the flag is re-checked; otherwise a build that completes in that window
would leave the caller parked forever (same pattern as
Repo::wait_for_scan).
Sourcepub fn set_page_links(&self, source_url: &str, links: &[OutboundLink])
pub fn set_page_links(&self, source_url: &str, links: &[OutboundLink])
Record source_url’s links, replacing whatever it contributed before.
links must already be resolved to absolute URLs (see
resolve_outbound_links); external links are ignored, since only an
internal target can display a backlink.
Sourcepub fn remove_page(&self, source_url: &str)
pub fn remove_page(&self, source_url: &str)
Remove every backlink contributed by source_url (the page was deleted).
Sourcepub fn get(&self, target_url: &str) -> Vec<InboundLink>
pub fn get(&self, target_url: &str) -> Vec<InboundLink>
Backlinks for target_url, in from order.
Sourcepub fn source_count(&self, target_url: &str) -> usize
pub fn source_count(&self, target_url: &str) -> usize
How many distinct pages link to target_url — a hash hit and a length,
no clone. Only meaningful once Self::is_ready; a miss before then is
“unknown”, not zero.
Sourcepub fn target_count(&self) -> usize
pub fn target_count(&self) -> usize
Number of pages that currently have at least one backlink recorded.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for InboundIndex
impl RefUnwindSafe for InboundIndex
impl Send for InboundIndex
impl Sync for InboundIndex
impl Unpin for InboundIndex
impl UnsafeUnpin for InboundIndex
impl UnwindSafe for InboundIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);