diff --git a/tracing-core/src/callsite.rs b/tracing-core/src/callsite.rs
index 5e48473e15..dfe5664f8c 100644
--- a/tracing-core/src/callsite.rs
+++ b/tracing-core/src/callsite.rs
@@ -77,12 +77,12 @@ impl Registry {
pub trait Callsite: Sync {
/// Sets the [`Interest`] for this callsite.
///
- /// [`Interest`]: ../subscriber/struct.Interest.html
+ /// [`Interest`]: super::subscriber::Interest
fn set_interest(&self, interest: Interest);
/// Returns the [metadata] associated with the callsite.
///
- /// [metadata]: ../metadata/struct.Metadata.html
+ /// [metadata]: super::metadata::Metadata
fn metadata(&self) -> &Metadata<'_>;
}
@@ -90,7 +90,7 @@ pub trait Callsite: Sync {
///
/// Two `Identifier`s are equal if they both refer to the same callsite.
///
-/// [`Callsite`]: ../callsite/trait.Callsite.html
+/// [`Callsite`]: super::callsite::Callsite
#[derive(Clone)]
pub struct Identifier(
/// **Warning**: The fields on this type are currently `pub` because it must
@@ -119,11 +119,11 @@ pub struct Identifier(
/// implementation at runtime, then it **must** call this function after that
/// value changes, in order for the change to be reflected.
///
-/// [`max_level_hint`]: ../subscriber/trait.Subscriber.html#method.max_level_hint
-/// [`Callsite`]: ../callsite/trait.Callsite.html
-/// [`enabled`]: ../subscriber/trait.Subscriber.html#tymethod.enabled
-/// [`Interest::sometimes()`]: ../subscriber/struct.Interest.html#method.sometimes
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
+/// [`max_level_hint`]: super::subscriber::Subscriber::max_level_hint
+/// [`Callsite`]: super::callsite::Callsite
+/// [`enabled`]: super::subscriber::Subscriber::enabled
+/// [`Interest::sometimes()`]: super::subscriber::Interest::sometimes
+/// [`Subscriber`]: super::subscriber::Subscriber
pub fn rebuild_interest_cache() {
let mut registry = REGISTRY.lock().unwrap();
registry.rebuild_interest();
diff --git a/tracing-core/src/dispatcher.rs b/tracing-core/src/dispatcher.rs
index 658463584e..f8ceabbfab 100644
--- a/tracing-core/src/dispatcher.rs
+++ b/tracing-core/src/dispatcher.rs
@@ -113,11 +113,10 @@
//!
//!
//!
-//! Note:the thread-local scoped dispatcher
-//! (with_default
) requires the
-//! Rust standard library. no_std
users should use
-//! set_global_default
-//! instead.
+//!
+//! **Note**: the thread-local scoped dispatcher ([`with_default`]) requires the
+//! Rust standard library. `no_std` users should use [`set_global_default`] instead.
+//!
//!
//!
//! ## Accessing the Default Subscriber
@@ -126,12 +125,6 @@
//! [`get_default`] function, which executes a closure with a reference to the
//! currently default `Dispatch`. This is used primarily by `tracing`
//! instrumentation.
-//!
-//! [`Subscriber`]: struct.Subscriber.html
-//! [`with_default`]: fn.with_default.html
-//! [`set_global_default`]: fn.set_global_default.html
-//! [`get_default`]: fn.get_default.html
-//! [`Dispatch`]: struct.Dispatch.html
use crate::{
callsite, span,
subscriber::{self, Subscriber},
@@ -154,8 +147,6 @@ use crate::stdlib::{
};
/// `Dispatch` trace data to a [`Subscriber`].
-///
-/// [`Subscriber`]: trait.Subscriber.html
#[derive(Clone)]
pub struct Dispatch {
subscriber: Arc,
@@ -217,14 +208,15 @@ pub struct DefaultGuard(Option);
///
///
/// Note: This function required the Rust standard library.
-/// no_std
users should use
-/// set_global_default
instead.
+///
+///
+/// `no_std` users should use [`set_global_default`] instead.
+///
///
///
-/// [span]: ../span/index.html
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
-/// [`Event`]: ../event/struct.Event.html
-/// [`set_global_default`]: ../fn.set_global_default.html
+/// [span]: super::span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn with_default(dispatcher: &Dispatch, f: impl FnOnce() -> T) -> T {
@@ -244,12 +236,11 @@ pub fn with_default(dispatcher: &Dispatch, f: impl FnOnce() -> T) -> T {
///
///
///
-/// Note: This function required the Rust standard library.
-/// no_std
users should use
-/// set_global_default
instead.
-///
///
-/// [`set_global_default`]: ../fn.set_global_default.html
+/// **Note**: This function required the Rust standard library.
+/// `no_std` users should use [`set_global_default`] instead.
+///
+///
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
#[must_use = "Dropping the guard unregisters the dispatcher."]
@@ -276,9 +267,9 @@ pub fn set_default(dispatcher: &Dispatch) -> DefaultGuard {
/// executables that depend on the library try to set the default later.
///
///
-/// [span]: ../span/index.html
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
-/// [`Event`]: ../event/struct.Event.html
+/// [span]: super::span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
pub fn set_global_default(dispatcher: Dispatch) -> Result<(), SetGlobalDefaultError> {
if GLOBAL_INIT.compare_and_swap(UNINITIALIZED, INITIALIZING, Ordering::SeqCst) == UNINITIALIZED
{
@@ -325,7 +316,7 @@ impl error::Error for SetGlobalDefaultError {}
/// called while inside of another `get_default`, that closure will be provided
/// with `Dispatch::none` rather than the previously set dispatcher.
///
-/// [dispatcher]: ../dispatcher/struct.Dispatch.html
+/// [dispatcher]: super::dispatcher::Dispatch
#[cfg(feature = "std")]
pub fn get_default(mut f: F) -> T
where
@@ -348,7 +339,7 @@ where
/// called while inside of another `get_default`, that closure will be provided
/// with `Dispatch::none` rather than the previously set dispatcher.
///
-/// [dispatcher]: ../dispatcher/struct.Dispatch.html
+/// [dispatcher]: super::dispatcher::Dispatch
#[cfg(feature = "std")]
#[doc(hidden)]
#[inline(never)]
@@ -363,7 +354,7 @@ pub fn get_current(f: impl FnOnce(&Dispatch) -> T) -> Option {
/// Executes a closure with a reference to the current [dispatcher].
///
-/// [dispatcher]: ../dispatcher/struct.Dispatch.html
+/// [dispatcher]: super::dispatcher::Dispatch
#[cfg(not(feature = "std"))]
#[doc(hidden)]
pub fn get_current(f: impl FnOnce(&Dispatch) -> T) -> Option {
@@ -373,7 +364,7 @@ pub fn get_current(f: impl FnOnce(&Dispatch) -> T) -> Option {
/// Executes a closure with a reference to the current [dispatcher].
///
-/// [dispatcher]: ../dispatcher/struct.Dispatch.html
+/// [dispatcher]: super::dispatcher::Dispatch
#[cfg(not(feature = "std"))]
pub fn get_default(mut f: F) -> T
where
@@ -412,7 +403,7 @@ impl Dispatch {
/// Returns a `Dispatch` that forwards to the given [`Subscriber`].
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
+ /// [`Subscriber`]: super::subscriber::Subscriber
pub fn new(subscriber: S) -> Self
where
S: Subscriber + Send + Sync + 'static,
@@ -434,8 +425,8 @@ impl Dispatch {
/// This calls the [`register_callsite`] function on the [`Subscriber`]
/// that this `Dispatch` forwards to.
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`register_callsite`]: ../subscriber/trait.Subscriber.html#method.register_callsite
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`register_callsite`]: super::subscriber::Subscriber::register_callsite
#[inline]
pub fn register_callsite(&self, metadata: &'static Metadata<'static>) -> subscriber::Interest {
self.subscriber.register_callsite(metadata)
@@ -448,9 +439,9 @@ impl Dispatch {
/// This calls the [`max_level_hint`] function on the [`Subscriber`]
/// that this `Dispatch` forwards to.
///
- /// [level]: ../struct.Level.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`register_callsite`]: ../subscriber/trait.Subscriber.html#method.max_level_hint
+ /// [level]: super::Level
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`register_callsite`]: super::subscriber::Subscriber::max_level_hint
// TODO(eliza): consider making this a public API?
#[inline]
pub(crate) fn max_level_hint(&self) -> Option {
@@ -463,9 +454,9 @@ impl Dispatch {
/// This calls the [`new_span`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [ID]: ../span/struct.Id.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
+ /// [ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
#[inline]
pub fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
self.subscriber.new_span(span)
@@ -476,8 +467,8 @@ impl Dispatch {
/// This calls the [`record`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`record`]: ../subscriber/trait.Subscriber.html#method.record
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`record`]: super::subscriber::Subscriber::record
#[inline]
pub fn record(&self, span: &span::Id, values: &span::Record<'_>) {
self.subscriber.record(span, values)
@@ -489,8 +480,8 @@ impl Dispatch {
/// This calls the [`record_follows_from`] function on the [`Subscriber`]
/// that this `Dispatch` forwards to.
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`record_follows_from`]: ../subscriber/trait.Subscriber.html#method.record_follows_from
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`record_follows_from`]: super::subscriber::Subscriber::record_follows_from
#[inline]
pub fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
self.subscriber.record_follows_from(span, follows)
@@ -502,9 +493,9 @@ impl Dispatch {
/// This calls the [`enabled`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [metadata]: ../metadata/struct.Metadata.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`enabled`]: ../subscriber/trait.Subscriber.html#method.enabled
+ /// [metadata]: super::metadata::Metadata
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`enabled`]: super::subscriber::Subscriber::enabled
#[inline]
pub fn enabled(&self, metadata: &Metadata<'_>) -> bool {
self.subscriber.enabled(metadata)
@@ -515,9 +506,9 @@ impl Dispatch {
/// This calls the [`event`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [`Event`]: ../event/struct.Event.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`event`]: ../subscriber/trait.Subscriber.html#method.event
+ /// [`Event`]: super::event::Event
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`event`]: super::subscriber::Subscriber::event
#[inline]
pub fn event(&self, event: &Event<'_>) {
self.subscriber.event(event)
@@ -528,8 +519,8 @@ impl Dispatch {
/// This calls the [`enter`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`enter`]: ../subscriber/trait.Subscriber.html#method.enter
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`enter`]: super::subscriber::Subscriber::enter
#[inline]
pub fn enter(&self, span: &span::Id) {
self.subscriber.enter(span);
@@ -540,8 +531,8 @@ impl Dispatch {
/// This calls the [`exit`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`exit`]: ../subscriber/trait.Subscriber.html#method.exit
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`exit`]: super::subscriber::Subscriber::exit
#[inline]
pub fn exit(&self, span: &span::Id) {
self.subscriber.exit(span);
@@ -557,10 +548,10 @@ impl Dispatch {
/// This calls the [`clone_span`] function on the `Subscriber` that this
/// `Dispatch` forwards to.
///
- /// [span ID]: ../span/struct.Id.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`clone_span`]: ../subscriber/trait.Subscriber.html#method.clone_span
- /// [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`clone_span`]: super::subscriber::Subscriber::clone_span
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
#[inline]
pub fn clone_span(&self, id: &span::Id) -> span::Id {
self.subscriber.clone_span(&id)
@@ -580,16 +571,17 @@ impl Dispatch {
/// ⚠ ️Warning
///
///
- /// Deprecated: The try_close
- /// method is functionally identical, but returns true
if the span is now closed.
+ ///
+ /// **Deprecated**: The [`try_close`] method is functionally identical, but returns `true` if the span is now closed.
/// It should be used instead of this method.
+ ///
///
///
- /// [span ID]: ../span/struct.Id.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`drop_span`]: ../subscriber/trait.Subscriber.html#method.drop_span
- /// [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
- /// [`try_close`]: #method.try_close
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`drop_span`]: super::subscriber::Subscriber::drop_span
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
+ /// [`try_close`]: Self::try_close
#[inline]
#[deprecated(since = "0.1.2", note = "use `Dispatch::try_close` instead")]
pub fn drop_span(&self, id: span::Id) {
@@ -608,10 +600,10 @@ impl Dispatch {
/// This calls the [`try_close`] function on the [`Subscriber`] that this
/// `Dispatch` forwards to.
///
- /// [span ID]: ../span/struct.Id.html
- /// [`Subscriber`]: ../subscriber/trait.Subscriber.html
- /// [`try_close`]: ../subscriber/trait.Subscriber.html#method.try_close
- /// [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`try_close`]: super::subscriber::Subscriber::try_close
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
#[inline]
pub fn try_close(&self, id: span::Id) -> bool {
self.subscriber.try_close(id)
@@ -622,7 +614,7 @@ impl Dispatch {
/// This calls the [`current`] function on the `Subscriber` that this
/// `Dispatch` forwards to.
///
- /// [`current`]: ../subscriber/trait.Subscriber.html#method.current
+ /// [`current`]: super::subscriber::Subscriber::current_span
#[inline]
pub fn current_span(&self) -> span::Current {
self.subscriber.current_span()
diff --git a/tracing-core/src/event.rs b/tracing-core/src/event.rs
index a0bfef0645..b823fa8722 100644
--- a/tracing-core/src/event.rs
+++ b/tracing-core/src/event.rs
@@ -81,7 +81,7 @@ impl<'a> Event<'a> {
/// Visits all the fields on this `Event` with the specified [visitor].
///
- /// [visitor]: ../field/trait.Visit.html
+ /// [visitor]: super::field::Visit
#[inline]
pub fn record(&self, visitor: &mut dyn field::Visit) {
self.fields.record(visitor);
@@ -94,7 +94,7 @@ impl<'a> Event<'a> {
/// Returns [metadata] describing this `Event`.
///
- /// [metadata]: ../struct.Metadata.html
+ /// [metadata]: super::Metadata
pub fn metadata(&self) -> &'static Metadata<'static> {
self.metadata
}
diff --git a/tracing-core/src/field.rs b/tracing-core/src/field.rs
index 1cda8d9cb8..b4787da669 100644
--- a/tracing-core/src/field.rs
+++ b/tracing-core/src/field.rs
@@ -27,17 +27,14 @@
//! we might record integers by incrementing counters for their field names,
//! rather than printing them.
//!
-//! [`Value`]: trait.Value.html
-//! [span]: ../span/
-//! [`Event`]: ../event/struct.Event.html
-//! [`Metadata`]: ../metadata/struct.Metadata.html
-//! [`Attributes`]: ../span/struct.Attributes.html
-//! [`Record`]: ../span/struct.Record.html
-//! [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
-//! [`record`]: ../subscriber/trait.Subscriber.html#method.record
-//! [`event`]: ../subscriber/trait.Subscriber.html#method.event
-//! [`Value::record`]: trait.Value.html#method.record
-//! [`Visit`]: trait.Visit.html
+//! [span]: super::span
+//! [`Event`]: super::event::Event
+//! [`Metadata`]: super::metadata::Metadata
+//! [`Attributes`]: super::span::Attributes
+//! [`Record`]: super::span::Record
+//! [`new_span`]: super::subscriber::Subscriber::new_span
+//! [`record`]: super::subscriber::Subscriber::record
+//! [`event`]: super::subscriber::Subscriber::event
use crate::callsite;
use crate::stdlib::{
borrow::Borrow,
@@ -179,13 +176,11 @@ pub struct Iter {
/// std::error::Error
trait.
///
///
-/// [`Value`]: trait.Value.html
-/// [recorded]: trait.Value.html#method.record
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
-/// [records an `Event`]: ../subscriber/trait.Subscriber.html#method.event
-/// [set of `Value`s added to a `Span`]: ../subscriber/trait.Subscriber.html#method.record
-/// [`Event`]: ../event/struct.Event.html
-/// [`ValueSet`]: struct.ValueSet.html
+/// [recorded]: Value::record
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [records an `Event`]: super::subscriber::Subscriber::event
+/// [set of `Value`s added to a `Span`]: super::subscriber::Subscriber::record
+/// [`Event`]: super::event::Event
pub trait Visit {
/// Visit a signed 64-bit integer value.
fn record_i64(&mut self, field: &Field, value: i64) {
@@ -233,7 +228,7 @@ pub trait Visit {
/// the [visitor] passed to their `record` method in order to indicate how
/// their data should be recorded.
///
-/// [visitor]: trait.Visit.html
+/// [visitor]: Visit
pub trait Value: crate::sealed::Sealed {
/// Visits this value with the given `Visitor`.
fn record(&self, key: &Field, visitor: &mut dyn Visit);
@@ -532,8 +527,8 @@ impl Field {
/// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
/// which defines this field.
///
- /// [`Identifier`]: ../callsite/struct.Identifier.html
- /// [`Callsite`]: ../callsite/trait.Callsite.html
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
#[inline]
pub fn callsite(&self) -> callsite::Identifier {
self.fields.callsite()
@@ -598,15 +593,15 @@ impl FieldSet {
/// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
/// which defines this set of fields..
///
- /// [`Identifier`]: ../callsite/struct.Identifier.html
- /// [`Callsite`]: ../callsite/trait.Callsite.html
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
pub(crate) fn callsite(&self) -> callsite::Identifier {
callsite::Identifier(self.callsite.0)
}
/// Returns the [`Field`] named `name`, or `None` if no such field exists.
///
- /// [`Field`]: ../struct.Field.html
+ /// [`Field`]: super::Field
pub fn field(&self, name: &Q) -> Option
where
Q: Borrow,
@@ -727,8 +722,8 @@ impl<'a> ValueSet<'a> {
/// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
/// defining the fields this `ValueSet` refers to.
///
- /// [`Identifier`]: ../callsite/struct.Identifier.html
- /// [`Callsite`]: ../callsite/trait.Callsite.html
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
#[inline]
pub fn callsite(&self) -> callsite::Identifier {
self.fields.callsite()
@@ -736,7 +731,7 @@ impl<'a> ValueSet<'a> {
/// Visits all the fields in this `ValueSet` with the provided [visitor].
///
- /// [visitor]: ../trait.Visit.html
+ /// [visitor]: super::Visit
pub(crate) fn record(&self, visitor: &mut dyn Visit) {
let my_callsite = self.callsite();
for (field, value) in self.values {
diff --git a/tracing-core/src/lib.rs b/tracing-core/src/lib.rs
index 8c257e864e..914b70167d 100644
--- a/tracing-core/src/lib.rs
+++ b/tracing-core/src/lib.rs
@@ -73,16 +73,16 @@
//! long as doing so complies with this policy.
//!
//!
-//! [`span::Id`]: span/struct.Id.html
-//! [`Event`]: event/struct.Event.html
-//! [`Subscriber`]: subscriber/trait.Subscriber.html
-//! [`Metadata`]: metadata/struct.Metadata.html
-//! [`Callsite`]: callsite/trait.Callsite.html
-//! [`Field`]: field/struct.Field.html
-//! [`FieldSet`]: field/struct.FieldSet.html
-//! [`Value`]: field/trait.Value.html
-//! [`ValueSet`]: field/struct.ValueSet.html
-//! [`Dispatch`]: dispatcher/struct.Dispatch.html
+//! [`span::Id`]: span::Id
+//! [`Event`]: event::Event
+//! [`Subscriber`]: subscriber::Subscriber
+//! [`Metadata`]: metadata::Metadata
+//! [`Callsite`]: callsite::Callsite
+//! [`Field`]: field::Field
+//! [`FieldSet`]: field::FieldSet
+//! [`Value`]: field::Value
+//! [`ValueSet`]: field::ValueSet
+//! [`Dispatch`]: dispatcher::Dispatch
//! [`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing
//! [`tracing`]: https://crates.io/crates/tracing
#![doc(html_root_url = "https://docs.rs/tracing-core/0.1.17")]
@@ -120,7 +120,7 @@ extern crate alloc;
/// Statically constructs an [`Identifier`] for the provided [`Callsite`].
///
/// This may be used in contexts, such as static initializers, where the
-/// [`Callsite::id`] function is not currently usable.
+/// [`Metadata::callsite`] function is not currently usable.
///
/// For example:
/// ```rust
@@ -146,9 +146,9 @@ extern crate alloc;
/// # }
/// ```
///
-/// [`Identifier`]: callsite/struct.Identifier.html
-/// [`Callsite`]: callsite/trait.Callsite.html
-/// [`Callsite::id`]: callsite/trait.Callsite.html#method.id
+/// [`Identifier`]: callsite::Identifier
+/// [`Callsite`]: callsite::Callsite
+/// [`Metadata::callsite`]: metadata::Metadata::callsite
#[macro_export]
macro_rules! identify_callsite {
($callsite:expr) => {
@@ -186,8 +186,8 @@ macro_rules! identify_callsite {
/// # }
/// ```
///
-/// [metadata]: metadata/struct.Metadata.html
-/// [`Metadata::new`]: metadata/struct.Metadata.html#method.new
+/// [metadata]: metadata::Metadata
+/// [`Metadata::new`]: metadata::Metadata::new
#[macro_export]
macro_rules! metadata {
(
diff --git a/tracing-core/src/metadata.rs b/tracing-core/src/metadata.rs
index 55fa2d64fd..7e05f7bdc0 100644
--- a/tracing-core/src/metadata.rs
+++ b/tracing-core/src/metadata.rs
@@ -38,26 +38,26 @@ use crate::stdlib::{
///
///
///
-/// Note: Although instances of Metadata
cannot
-/// be compared directly, they provide a method
-/// id
, returning an opaque
-/// callsite identifier which uniquely identifies the callsite where the metadata
-/// originated. This can be used to determine if two Metadata
correspond to
-/// the same callsite.
+///
+/// **Note**: Although instances of `Metadata` cannot
+/// be compared directly, they provide a method [`callsite`][Metadata::callsite],
+/// returning an opaque [callsite identifier] which uniquely identifies the
+/// callsite where the metadata originated. This can be used to determine if two
+/// `Metadata` correspond to the same callsite.
+///
///
///
-/// [span]: ../span/index.html
-/// [event]: ../event/index.html
-/// [name]: #method.name
-/// [target]: #method.target
-/// [fields]: #method.fields
-/// [verbosity level]: #method.level
-/// [file name]: #method.file
-/// [line number]: #method.line
-/// [module path]: #method.module
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
-/// [`id`]: struct.Metadata.html#method.id
-/// [callsite identifier]: ../callsite/struct.Identifier.html
+/// [span]: super::span
+/// [event]: super::event
+/// [name]: Self::name
+/// [target]: Self::target
+/// [fields]: Self::fields
+/// [verbosity level]: Self::level
+/// [file name]: Self::file
+/// [line number]: Self::line
+/// [module path]: Self::module_path
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [callsite identifier]: super::callsite::Identifier
pub struct Metadata<'a> {
/// The name of the span described by this metadata.
name: &'static str,
@@ -408,7 +408,7 @@ impl LevelFilter {
/// Returns the most verbose [`Level`] that this filter accepts, or `None`
/// if it is [`OFF`].
///
- /// [`Level`]: ../struct.Level.html
+ /// [`Level`]: super::Level
/// [`OFF`]: #associatedconstant.OFF
pub const fn into_level(self) -> Option {
self.0
@@ -442,8 +442,8 @@ impl LevelFilter {
/// *disabled*, but **should not** be used for determining if something is
/// *enabled*.`
///
- /// [`Level`]: ../struct.Level.html
- /// [`Subscriber`]: ../../trait.Subscriber.html
+ /// [`Level`]: super::Level
+ /// [`Subscriber`]: super::Subscriber
#[inline(always)]
pub fn current() -> Self {
match MAX_LEVEL.load(Ordering::Relaxed) {
diff --git a/tracing-core/src/span.rs b/tracing-core/src/span.rs
index 27dda2475c..e890e23619 100644
--- a/tracing-core/src/span.rs
+++ b/tracing-core/src/span.rs
@@ -9,8 +9,8 @@ use crate::{field, Metadata};
/// the [`new_span`] trait method. See the documentation for that method for
/// more information on span ID generation.
///
-/// [`Subscriber`]: ../subscriber/trait.Subscriber.html
-/// [`new_span`]: ../subscriber/trait.Subscriber.html#method.new_span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`new_span`]: super::subscriber::Subscriber::new_span
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Id(NonZeroU64);
@@ -37,9 +37,9 @@ pub struct Record<'a> {
/// - "none", indicating that the current context is known to not be in a span,
/// - "some", with the current span's [`Id`] and [`Metadata`].
///
-/// [the `Subscriber` considers]: ../subscriber/trait.Subscriber.html#method.current_span
-/// [`Id`]: struct.Id.html
-/// [`Metadata`]: ../metadata/struct.Metadata.html
+/// [the `Subscriber` considers]: super::subscriber::Subscriber::current_span
+/// [`Id`]: Id
+/// [`Metadata`]: super::metadata::Metadata
#[derive(Debug)]
pub struct Current {
inner: CurrentInner,
@@ -75,7 +75,7 @@ impl Id {
/// Constructs a new span ID from the given `NonZeroU64`.
///
- /// Unlike [`Id::from_u64`](#method.from_u64), this will never panic.
+ /// Unlike [`Id::from_u64`](Self::from_u64), this will never panic.
#[inline]
pub const fn from_non_zero_u64(id: NonZeroU64) -> Self {
Id(id)
@@ -181,7 +181,7 @@ impl<'a> Attributes<'a> {
/// Records all the fields in this set of `Attributes` with the provided
/// [Visitor].
///
- /// [visitor]: ../field/trait.Visit.html
+ /// [visitor]: super::field::Visit
pub fn record(&self, visitor: &mut dyn field::Visit) {
self.values.record(visitor)
}
@@ -208,7 +208,7 @@ impl<'a> Record<'a> {
/// Records all the fields in this `Record` with the provided [Visitor].
///
- /// [visitor]: ../field/trait.Visit.html
+ /// [visitor]: super::field::Visit
pub fn record(&self, visitor: &mut dyn field::Visit) {
self.values.record(visitor)
}
@@ -260,9 +260,9 @@ impl Current {
/// `None`, but in this case, that is because the subscriber does not keep
/// track of the currently-entered span.
///
- /// [`id`]: #method.id
- /// [`metadata`]: #method.metadata
- /// [`into_inner`]: #method.into_inner
+ /// [`id`]: Self::id
+ /// [`metadata`]: Self::metadata
+ /// [`into_inner`]: Self::into_inner
pub fn is_known(&self) -> bool {
!matches!(self.inner, CurrentInner::Unknown)
}
diff --git a/tracing-core/src/subscriber.rs b/tracing-core/src/subscriber.rs
index cc62ee8584..7d3f7fb8b0 100644
--- a/tracing-core/src/subscriber.rs
+++ b/tracing-core/src/subscriber.rs
@@ -60,13 +60,13 @@ use crate::stdlib::any::{Any, TypeId};
/// Subscribers which store per-span data or which need to track span closures
/// should override these functions together.
///
-/// [ID]: ../span/struct.Id.html
-/// [`new_span`]: trait.Subscriber.html#method.new_span
-/// [`register_callsite`]: trait.Subscriber.html#method.register_callsite
-/// [`Interest`]: struct.Interest.html
-/// [`enabled`]: trait.Subscriber.html#method.enabled
-/// [`clone_span`]: trait.Subscriber.html#method.clone_span
-/// [`try_close`]: trait.Subscriber.html#method.try_close
+/// [ID]: super::span::Id
+/// [`new_span`]: Subscriber::new_span
+/// [`register_callsite`]: Subscriber::register_callsite
+/// [`Interest`]: Interest
+/// [`enabled`]: Subscriber::enabled
+/// [`clone_span`]: Subscriber::clone_span
+/// [`try_close`]: Subscriber::try_close
pub trait Subscriber: 'static {
// === Span registry methods ==============================================
@@ -96,7 +96,7 @@ pub trait Subscriber: 'static {
/// never be enabled unless a new subscriber expresses interest in it.
///
/// `Subscriber`s which require their filters to be run every time an event
- /// occurs or a span is entered/exited should return `Interest::sometimes`.
+ /// occurs or a span is entered::exited should return `Interest::sometimes`.
/// If a subscriber returns `Interest::sometimes`, then its' [`enabled`] method
/// will be called every time an event or span is created from that callsite.
///
@@ -132,11 +132,11 @@ pub trait Subscriber: 'static {
/// _may_ still see spans and events originating from that callsite, if
/// another subscriber expressed interest in it.
///
- /// [filter]: #method.enabled
- /// [metadata]: ../metadata/struct.Metadata.html
- /// [`Interest`]: struct.Interest.html
- /// [`enabled`]: #method.enabled
- /// [`rebuild_interest_cache`]: ../callsite/fn.rebuild_interest_cache.html
+ /// [filter]: Self::enabled
+ /// [metadata]: super::metadata::Metadata
+ /// [`Interest`]: Interest
+ /// [`enabled`]: Self::enabled
+ /// [`rebuild_interest_cache`]: super::callsite::fn.rebuild_interest_cache.html
fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
if self.enabled(metadata) {
Interest::always()
@@ -161,10 +161,10 @@ pub trait Subscriber: 'static {
/// [`Interest::sometimes`]. In that case, this function will be called every
/// time that span or event occurs.
///
- /// [metadata]: ../metadata/struct.Metadata.html
- /// [interested]: struct.Interest.html
- /// [`Interest::sometimes`]: struct.Interest.html#method.sometimes
- /// [`register_callsite`]: #method.register_callsite
+ /// [metadata]: super::metadata::Metadata
+ /// [interested]: Interest
+ /// [`Interest::sometimes`]: Interest::sometimes
+ /// [`register_callsite`]: Self::register_callsite
fn enabled(&self, metadata: &Metadata<'_>) -> bool;
/// Returns the highest [verbosity level][level] that this `Subscriber` will
@@ -187,9 +187,9 @@ pub trait Subscriber: 'static {
/// [`rebuild_interest_cache`][rebuild] is called after the value of the max
/// level changes.
///
- /// [level]: ../struct.Level.html
- /// [`Interest`]: struct.Interest.html
- /// [rebuild]: ../callsite/fn.rebuild_interest_cache.html
+ /// [level]: super::Level
+ /// [`Interest`]: Interest
+ /// [rebuild]: super::callsite::fn.rebuild_interest_cache.html
fn max_level_hint(&self) -> Option {
None
}
@@ -214,10 +214,10 @@ pub trait Subscriber: 'static {
/// scheme it sees fit. Any guarantees about uniqueness, ordering, or ID
/// reuse are left up to the subscriber implementation to determine.
///
- /// [span ID]: ../span/struct.Id.html
- /// [`Attributes`]: ../span/struct.Attributes.html
- /// [visitor]: ../field/trait.Visit.html
- /// [`record` method]: ../span/struct.Attributes.html#method.record
+ /// [span ID]: super::span::Id
+ /// [`Attributes`]: super::span::Attributes
+ /// [visitor]: super::field::Visit
+ /// [`record` method]: super::span::Attributes::record
fn new_span(&self, span: &span::Attributes<'_>) -> span::Id;
// === Notification methods ===============================================
@@ -256,9 +256,9 @@ pub trait Subscriber: 'static {
/// span.record("baz", &"a string");
/// ```
///
- /// [visitor]: ../field/trait.Visit.html
- /// [`record`]: ../span/struct.Attributes.html#method.record
- /// [`record` method]: ../span/struct.Record.html#method.record
+ /// [visitor]: super::field::Visit
+ /// [`record`]: super::span::Attributes::record
+ /// [`record` method]: super::span::Record::record
fn record(&self, span: &span::Id, values: &span::Record<'_>);
/// Adds an indication that `span` follows from the span with the id
@@ -295,10 +295,10 @@ pub trait Subscriber: 'static {
/// event. The subscriber may pass a [visitor] to the `Event`'s
/// [`record` method] to record these values.
///
- /// [`Event`]: ../event/struct.Event.html
- /// [visitor]: ../field/trait.Visit.html
- /// [`record` method]: ../event/struct.Event.html#method.record
- /// [`dispatch` method]: ../event/struct.Event.html#method.dispatch
+ /// [`Event`]: super::event::Event
+ /// [visitor]: super::field::Visit
+ /// [`record` method]: super::event::Event::record
+ /// [`dispatch` method]: super::event::Event::dispatch
fn event(&self, event: &Event<'_>);
/// Records that a span has been entered.
@@ -308,7 +308,7 @@ pub trait Subscriber: 'static {
/// [span ID] of the entered span, and should update any internal state
/// tracking the current span accordingly.
///
- /// [span ID]: ../span/struct.Id.html
+ /// [span ID]: super::span::Id
fn enter(&self, span: &span::Id);
/// Records that a span has been exited.
@@ -320,7 +320,7 @@ pub trait Subscriber: 'static {
///
/// Exiting a span does not imply that the span will not be re-entered.
///
- /// [span ID]: ../span/struct.Id.html
+ /// [span ID]: super::span::Id
fn exit(&self, span: &span::Id);
/// Notifies the subscriber that a [span ID] has been cloned.
@@ -341,8 +341,8 @@ pub trait Subscriber: 'static {
/// kind this can be used as a hook to "clone" the pointer, depending on
/// what that means for the specified pointer.
///
- /// [span ID]: ../span/struct.Id.html
- /// [`try_close`]: trait.Subscriber.html#method.try_close
+ /// [span ID]: super::span::Id
+ /// [`try_close`]: Subscriber::try_close
fn clone_span(&self, id: &span::Id) -> span::Id {
id.clone()
}
@@ -355,7 +355,7 @@ pub trait Subscriber: 'static {
///
/// The default implementation of this function does nothing.
///
- /// [`try_close`]: trait.Subscriber.html#method.try_close
+ /// [`try_close`]: Subscriber::try_close
#[deprecated(since = "0.1.2", note = "use `Subscriber::try_close` instead")]
fn drop_span(&self, _id: span::Id) {}
@@ -392,9 +392,9 @@ pub trait Subscriber: 'static {
/// inside of a `try_close` function may cause a double panic, if the span
/// was dropped due to a thread unwinding.
///
- /// [span ID]: ../span/struct.Id.html
- /// [`clone_span`]: trait.Subscriber.html#method.clone_span
- /// [`drop_span`]: trait.Subscriber.html#method.drop_span
+ /// [span ID]: super::span::Id
+ /// [`clone_span`]: Subscriber::clone_span
+ /// [`drop_span`]: Subscriber::drop_span
fn try_close(&self, id: span::Id) -> bool {
#[allow(deprecated)]
self.drop_span(id);
@@ -412,8 +412,8 @@ pub trait Subscriber: 'static {
/// does **not** track what span is current. If the subscriber does not
/// implement a current span, it should not override this method.
///
- /// [`Current::new`]: ../span/struct.Current.html#tymethod.new
- /// [`Current::none`]: ../span/struct.Current.html#tymethod.none
+ /// [`Current::new`]: super::span::Current::new
+ /// [`Current::none`]: super::span::Current::none
fn current_span(&self) -> span::Current {
span::Current::unknown()
}
@@ -479,8 +479,8 @@ impl dyn Subscriber {
/// `Subscriber`s return an `Interest` from their [`register_callsite`] methods
/// in order to determine whether that span should be enabled or disabled.
///
-/// [`Subscriber`]: ../trait.Subscriber.html
-/// [`register_callsite`]: ../trait.Subscriber.html#method.register_callsite
+/// [`Subscriber`]: super::Subscriber
+/// [`register_callsite`]: super::Subscriber::register_callsite
#[derive(Clone, Debug)]
pub struct Interest(InterestKind);