Struct ServerBuilder

Source
pub struct ServerBuilder { /* private fields */ }
Expand description

ServerBuilder is used to first register closures to events before finally building a tide::Server using those closures.

Implementations§

Source§

impl ServerBuilder

Source

pub fn on<E: Into<Event>>( self, event: E, handler: impl Fn(Payload) + Send + Sync + 'static, ) -> Self

Registers the given event handler to be run when the given event is received.

The event handler receives a Payload as the single argument. Since webhooks are generally passively consumed (Github will not meaningfully (to us) process our response), the handler returns only a (). As far as the event dispatcher is concerned, all the meaningful work will be done as side-effects of the closures you register here.

The types involved here are not stable yet due to ongoing API development.

§Example
    let github = tide_github::new("my webhook s3ct#t")
        .on(Event::IssueComment, |payload| {
            println!("Got payload for repository {}", payload.repository.name)
        });
Source

pub fn build(self) -> Server<()>

Build a tide::Server using the registered events.

Since the API is still in development, in the future we might instead (or additionally) expose the EventHandlerDispatcher directly.

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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