Struct FireBuilder

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

FireBuilder gathers all materials needed to light a fire (start a server).

Implementations§

Source§

impl FireBuilder

Source

pub fn data(&self) -> &Resources

Returns a reference to the current data.

Source

pub fn add_data<D>(&mut self, data: D)
where D: Any + Send + Sync,

Source

pub fn add_raw_route<R>(&mut self, route: R)
where R: RawRoute + 'static,

Adds a RawRoute to the fire.

Source

pub fn add_route<R>(&mut self, route: R)
where R: IntoRoute + 'static,

Adds a Route to the fire.

Source

pub fn add_catcher<C>(&mut self, catcher: C)
where C: Catcher + 'static,

Adds a Catcher to the fire.

Source

pub fn request_size_limit(&mut self, size_limit: usize)

Sets the request size limit. The default is 4 kilobytes.

This can be changed in every Route.

§Panics

If the size is zero.

Source

pub fn request_timeout(&mut self, timeout: Duration)

Sets the request timeout. The default is 60 seconds.

This can be changed in every Route.

Source

pub async fn build(self) -> Result<Fire>

Binds to the address and prepares to serve requests.

You need to call ignite on the Fire so that it starts handling requests.

Source

pub async fn ignite(self) -> Result<()>

Ignites the fire, which starts the server.

§Note

Under normal conditions this function should run forever.

Source

pub fn ignite_task(self) -> JoinHandle<()>

Ignites the fire, and spawns it on a new tokio task.

§Note

Under normal conditions this task should run forever.

Source

pub fn into_pit(self) -> FirePit

Creates a FirePit without starting the server.

In most cases you should use build and then call pit on the Fire.

Creating a FirePit might be useful for testing or if you want to manually create a server.

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,