Skip to content

tracing-subscriber: change try_init error type to TryInitError #2158

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.

Sign up for GitHub

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

Open
daxpedda wants to merge 1 commit into
base: master
Choose a base branch
from
Open

tracing-subscriber: change try_init error type to TryInitError #2158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 9 additions & 12 deletions tracing-subscriber/src/fmt/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@
//! [`Collect`]: https://docs.rs/tracing/latest/tracing/trait.Collect.html
//! [`tracing`]: https://crates.io/crates/tracing
//! [`fmt::format`]: mod@crate::fmt::format
use std::{any::TypeId, error::Error, io, ptr::NonNull};
use std::{any::TypeId, io, ptr::NonNull};
use tracing_core::{collect::Interest, span, Event, Metadata};

mod fmt_subscriber;
Expand All @@ -208,6 +208,7 @@ use crate::{
filter::LevelFilter,
registry::{LookupSpan, Registry},
reload, subscribe,
util::TryInitError,
};

#[doc(inline)]
Expand Down Expand Up @@ -278,18 +279,16 @@ pub struct CollectorBuilder<
/// [`try_init`] returns an error if the default collector could not be set:
///
/// ```rust
/// use std::error::Error;
/// use tracing_subscriber::util::TryInitError;
///
/// fn init_subscriber() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
/// fn init_subscriber() -> Result<(), TryInitError> {
/// tracing_subscriber::fmt()
/// // Configure the collector to emit logs in JSON format.
/// .json()
/// // Configure the collector to flatten event fields in the output JSON objects.
/// .flatten_event(true)
/// // Set the collector as the default, returning an error if this fails.
/// .try_init()?;
///
/// Ok(())
/// .try_init()
/// }
/// ```
///
Expand Down Expand Up @@ -487,11 +486,9 @@ where
/// Returns an Error if the initialization was unsuccessful, likely
/// because a global collector was already installed by another
/// call to `try_init`.
pub fn try_init(self) -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
pub fn try_init(self) -> Result<(), TryInitError> {
use crate::util::SubscriberInitExt;
self.finish().try_init()?;

Ok(())
self.finish().try_init()
}

/// Install this collector as the global default.
Expand Down Expand Up @@ -1046,7 +1043,7 @@ impl<N, E, F, W> CollectorBuilder<N, E, F, W> {
/// This is shorthand for
///
/// ```rust
/// # fn doc() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
/// # fn doc() -> Result<(), tracing_subscriber::util::TryInitError> {
/// tracing_subscriber::fmt().try_init()
/// # }
/// ```
Expand All @@ -1062,7 +1059,7 @@ impl<N, E, F, W> CollectorBuilder<N, E, F, W> {
/// https://docs.rs/tracing-log/0.1.0/tracing_log/struct.LogTracer.html
/// [`RUST_LOG` environment variable]:
/// ../filter/struct.EnvFilter.html#associatedconstant.DEFAULT_ENV
pub fn try_init() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
pub fn try_init() -> Result<(), TryInitError> {
let builder = Collector::builder();

#[cfg(feature = "env-filter")]
Expand Down