pub struct Hub { /* private fields */ }Expand description
The central object that can manages scopes and clients.
This can be used to capture events and manage the scope. This object is internally synchronized so it can be used from multiple threads if needed. The default hub that is available automatically is thread local.
In most situations developers do not need to interface the hub. Instead
toplevel convenience functions are expose tht will automatically dispatch
to global (Hub::current) hub. In some situations this might not be
possible in which case it might become necessary to manually work with the
hub. This is for instance the case when working with async code.
Hubs that are wrapped in Arcs can be bound to the current thread with
the run static method.
Most common operations:
Hub::new: creates a brand new hubHub::current: returns the thread local hubHub::with: invoke a callback with the thread local hubHub::with_active: likeHub::withbut does not invoke the callback if the client is not in a supported state or not boundHub::new_from_top: creates a new hub with just the top scope of another hub.
Implementations§
source§impl Hub
impl Hub
sourcepub fn new(client: Option<Arc<Client>>, scope: Arc<Scope>) -> Hub
pub fn new(client: Option<Arc<Client>>, scope: Arc<Scope>) -> Hub
Creates a new hub from the given client and scope.
sourcepub fn new_from_top<H: AsRef<Hub>>(other: H) -> Hub
pub fn new_from_top<H: AsRef<Hub>>(other: H) -> Hub
Creates a new hub based on the top scope of the given hub.
sourcepub fn current() -> Arc<Hub>
pub fn current() -> Arc<Hub>
Returns the current hub.
By default each thread gets a different thread local hub. If an
atomically reference counted hub is available it can override this
one here by calling Hub::run with a closure.
This method is unavailable if the client implementation is disabled.
When using the minimal API set use Hub::with_active instead.
sourcepub fn main() -> Arc<Hub>
pub fn main() -> Arc<Hub>
Returns the main thread’s hub.
This is similar to current but instead of picking the current
thread’s hub it returns the main thread’s hub instead.
sourcepub fn with<F, R>(f: F) -> Rwhere
F: FnOnce(&Arc<Hub>) -> R,
pub fn with<F, R>(f: F) -> Rwhere
F: FnOnce(&Arc<Hub>) -> R,
Invokes the callback with the default hub.
This is a slightly more efficient version than Hub::current() and
also unavailable in minimal mode.
sourcepub fn with_active<F, R>(f: F) -> Rwhere
F: FnOnce(&Arc<Hub>) -> R,
R: Default,
pub fn with_active<F, R>(f: F) -> Rwhere
F: FnOnce(&Arc<Hub>) -> R,
R: Default,
Like Hub::with but only calls the function if a client is bound.
This is useful for integrations that want to do efficiently nothing if there is no client bound. Additionally this internally ensures that the client can be safely synchronized. This prevents accidental recursive calls into the client.
sourcepub fn run<F: FnOnce() -> R, R>(hub: Arc<Hub>, f: F) -> R
pub fn run<F: FnOnce() -> R, R>(hub: Arc<Hub>, f: F) -> R
Binds a hub to the current thread for the duration of the call.
sourcepub fn last_event_id(&self) -> Option<Uuid>
pub fn last_event_id(&self) -> Option<Uuid>
Returns the last event id.
sourcepub fn capture_event(&self, event: Event<'static>) -> Uuid
pub fn capture_event(&self, event: Event<'static>) -> Uuid
Sends the event to the current client with the current scope.
In case no client is bound this does nothing instead.
sourcepub fn capture_message(&self, msg: &str, level: Level) -> Uuid
pub fn capture_message(&self, msg: &str, level: Level) -> Uuid
Captures an arbitrary message.
sourcepub fn bind_client(&self, client: Option<Arc<Client>>)
pub fn bind_client(&self, client: Option<Arc<Client>>)
Binds a new client to the hub.
sourcepub fn push_scope(&self) -> ScopeGuard
pub fn push_scope(&self) -> ScopeGuard
Pushes a new scope.
This returns a guard that when dropped will pop the scope again.
sourcepub fn with_scope<C, F, R>(&self, scope_config: C, callback: F) -> Rwhere
C: FnOnce(&mut Scope),
F: FnOnce() -> R,
pub fn with_scope<C, F, R>(&self, scope_config: C, callback: F) -> Rwhere
C: FnOnce(&mut Scope),
F: FnOnce() -> R,
Temporarily pushes a scope for a single call optionally reconfiguring it.
This works the same as the global with_scope function.
sourcepub fn configure_scope<F, R>(&self, f: F) -> Rwhere
R: Default,
F: FnOnce(&mut Scope) -> R,
pub fn configure_scope<F, R>(&self, f: F) -> Rwhere
R: Default,
F: FnOnce(&mut Scope) -> R,
Invokes a function that can modify the current scope.
This works the same as the global configure_scope function.
Adds a new breadcrumb to the current scope.
This is equivalent to the global sentry::add_breadcrumb but
sends the breadcrumb into the hub instead.