Skip to main content

HookConfig

Struct HookConfig 

Source
pub struct HookConfig<K> {
    pub name: Arc<str>,
    pub endpoint: Endpoint,
    pub events: BTreeSet<K>,
    pub queue_capacity: usize,
    pub maximum_in_flight: usize,
    pub maximum_attempts: u32,
    pub bearer: Option<BearerToken>,
    pub signing_secret: Option<SigningSecret>,
    pub client: Option<HttpClient>,
}
Expand description

One configured destination.

Fields§

§name: Arc<str>

Identifies this hook in metrics and logs, so it must be unique.

§endpoint: Endpoint§events: BTreeSet<K>

Only these are delivered. Explicit rather than defaulting to everything, so a consumer written today cannot be sent an event type added later.

§queue_capacity: usize

Capacity of both bounded stages. Ingress is normally empty; the dispatcher-owned stage is the durable in-memory backlog that applies drop-oldest while an endpoint is unhealthy.

§maximum_in_flight: usize

Distinct subjects that may be in flight at once. One request per subject is the ordering rule, so this is also the concurrency.

§maximum_attempts: u32

Attempts per event, the first included.

§bearer: Option<BearerToken>§signing_secret: Option<SigningSecret>

Optional Standard Webhooks HMAC-SHA256 signing key.

§client: Option<HttpClient>

A client of this destination’s own, or None to use the shared one.

Present only when a destination asked for something a shared pool cannot give it: a client certificate, or an authority pinned in place of the platform store. Both belong to this endpoint, and a pooled connection reused across endpoints would present one service’s identity to another — so asking for either costs a pool, and only the endpoints that ask pay for one.

Implementations§

Source§

impl<K> HookConfig<K>

Source

pub fn validate(&self) -> Result<(), ConfigError>

Checks transport invariants independently of the application’s parser.

Trait Implementations§

Source§

impl<K: Clone> Clone for HookConfig<K>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<K> Debug for HookConfig<K>
where BTreeSet<K>: Debug,

Source§

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<K> !Freeze for HookConfig<K>

§

impl<K> !RefUnwindSafe for HookConfig<K>

§

impl<K> !UnwindSafe for HookConfig<K>

§

impl<K> Forget for HookConfig<K>

§

impl<K> Move for HookConfig<K>

§

impl<K> Send for HookConfig<K>
where BTreeSet<K>: Send,

§

impl<K> Sync for HookConfig<K>
where BTreeSet<K>: Sync,

§

impl<K> Unpin for HookConfig<K>
where BTreeSet<K>: Unpin,

§

impl<K> UnsafeUnpin for HookConfig<K>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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