Struct tracing_layer_core::layer::WebhookLayerBuilder

source ·
pub struct WebhookLayerBuilder<C: Config, F: WebhookMessageFactory> { /* private fields */ }
Expand description

A builder for creating a webhook layer.

The layer requires a regex for selecting events to be sent to Discord by their target. Specifying no filter (e.g. “.*”) will cause an explosion in the number of messages observed by the layer.

Several methods expose initialization of optional filtering mechanisms, along with Discord configuration that defaults to searching in the local environment variables.

Implementations§

source§

impl<C: Config, F: WebhookMessageFactory> WebhookLayerBuilder<C, F>

source

pub fn message_filters(self, filters: EventFilters) -> Self

Filter events by their message.

Filter type semantics:

  • Positive: Exclude an event if the message MATCHES a given regex, and
  • Negative: Exclude an event if the message does NOT MATCH a given regex.
source

pub fn event_by_field_filters(self, filters: EventFilters) -> Self

Filter events by fields.

Filter type semantics:

  • Positive: Exclude the event if its key MATCHES a given regex.
  • Negative: Exclude the event if its key does NOT MATCH a given regex.
source

pub fn field_exclusion_filters(self, filters: Vec<Regex>) -> Self

Filter fields of events from being sent to Discord.

Filter type semantics:

  • Positive: Exclude event fields if the field’s key MATCHES any provided regular expressions.
source

pub fn config(self, config: C) -> Self

Configure the layer’s connection to the Discord Webhook API.

source

pub fn level_filters(self, level_filters: String) -> Self

Configure which levels of events to send to Discord.

source

pub fn build(self) -> (WebhookLayer<C, F>, BackgroundWorker)

Create a DiscordLayer and its corresponding background worker to (async) send the messages.

Auto Trait Implementations§

§

impl<C, F> Freeze for WebhookLayerBuilder<C, F>
where C: Freeze,

§

impl<C, F> RefUnwindSafe for WebhookLayerBuilder<C, F>

§

impl<C, F> Send for WebhookLayerBuilder<C, F>
where F: Send, C: Send,

§

impl<C, F> Sync for WebhookLayerBuilder<C, F>
where F: Sync, C: Sync,

§

impl<C, F> Unpin for WebhookLayerBuilder<C, F>
where F: Unpin, C: Unpin,

§

impl<C, F> UnwindSafe for WebhookLayerBuilder<C, F>
where F: UnwindSafe, C: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more