Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make NoSubscriber public and move it to tracing_core::subscriber #1549

Merged
merged 3 commits into from
Sep 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 4 additions & 30 deletions tracing-core/src/dispatcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
//! [`Dispatch`]: struct.Dispatch.html
use crate::{
callsite, span,
subscriber::{self, Subscriber},
subscriber::{self, NoSubscriber, Subscriber},
Event, LevelFilter, Metadata,
};

Expand Down Expand Up @@ -404,7 +404,7 @@ impl Dispatch {
#[inline]
pub fn none() -> Self {
Dispatch {
subscriber: Arc::new(NoSubscriber),
subscriber: Arc::new(NoSubscriber::default()),
}
}

Expand Down Expand Up @@ -661,32 +661,6 @@ where
}
}

struct NoSubscriber;
impl Subscriber for NoSubscriber {
#[inline]
fn register_callsite(&self, _: &'static Metadata<'static>) -> subscriber::Interest {
subscriber::Interest::never()
}

fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
span::Id::from_u64(0xDEAD)
}

fn event(&self, _event: &Event<'_>) {}

fn record(&self, _span: &span::Id, _values: &span::Record<'_>) {}

fn record_follows_from(&self, _span: &span::Id, _follows: &span::Id) {}

#[inline]
fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
false
}

fn enter(&self, _span: &span::Id) {}
fn exit(&self, _span: &span::Id) {}
}

impl Registrar {
pub(crate) fn try_register(
&self,
Expand Down Expand Up @@ -789,13 +763,13 @@ mod test {

#[test]
fn dispatch_is() {
let dispatcher = Dispatch::new(NoSubscriber);
let dispatcher = Dispatch::new(NoSubscriber::default());
assert!(dispatcher.is::<NoSubscriber>());
}

#[test]
fn dispatch_downcasts() {
let dispatcher = Dispatch::new(NoSubscriber);
let dispatcher = Dispatch::new(NoSubscriber::default());
assert!(dispatcher.downcast_ref::<NoSubscriber>().is_some());
}

Expand Down
38 changes: 38 additions & 0 deletions tracing-core/src/subscriber.rs
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,44 @@ impl Interest {
}
}

/// A no-op [`Subscriber`]
///
/// [`NoSubscriber`] implements the [`Subscriber`] trait by never being enabled,
/// never being interested in any callsite, and drops all spans and events.
#[derive(Debug, Copy, Clone)]
pub struct NoSubscriber(());

impl Default for NoSubscriber {
fn default() -> Self {
NoSubscriber(())
}
}

impl Subscriber for NoSubscriber {
#[inline]
fn register_callsite(&self, _: &'static Metadata<'static>) -> Interest {
Interest::never()
}

fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
span::Id::from_u64(0xDEAD)
}

fn event(&self, _event: &Event<'_>) {}

fn record(&self, _span: &span::Id, _values: &span::Record<'_>) {}

fn record_follows_from(&self, _span: &span::Id, _follows: &span::Id) {}

#[inline]
fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
false
}

fn enter(&self, _span: &span::Id) {}
fn exit(&self, _span: &span::Id) {}
}

impl Subscriber for Box<dyn Subscriber + Send + Sync + 'static> {
#[inline]
fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
Expand Down