Struct WebTemplate

pub struct WebTemplate<T: Template>(pub T);

Wrap a Template that might not derive WebTemplate to be usable as web response.

A Template wrapped in this struct implements all traits that were enabled through feature flags. Please see the crate documentation for a list of all supported feature flags / web frameworks.

You might also find WebTemplateExt::into_web_template() convenient.

Tuple Fields

0: T

Trait Implementations

impl<T: Clone + Template> Clone for WebTemplate<T>

fn clone(&self) -> WebTemplate<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Template> Debug for WebTemplate<T>

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

Formats the value using the given formatter.

impl<T: Template> Display for WebTemplate<T>

Implement the format!() trait for WebTemplate<T>.

Please be aware of the rendering performance notice in the Template trait.

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

Formats the value using the given formatter.

impl<T: Template> FastWritable for WebTemplate<T>

fn write_into<W: Write + ?Sized>(&self, dest: &mut W) -> Result<()>

Used internally by askama to speed up writing some types.

impl<T: Template + Send + Sync + 'static> Handler for WebTemplate<T>

Available on crate feature trillium-0.2 only.

fn run<'a: 'b, 'b>( &'a self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'b>>

where Self: 'b,

Executes this handler, performing any modifications to the Conn that are desired.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, _info: &'life1 mut Info, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn, ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement Handler::upgrade. The first handler that responds true to this will receive ownership of the trillium::Upgrade in a subsequent call to Handler::upgrade

fn upgrade<'life0, 'async_trait>( &'life0 self, _upgrade: Upgrade<BoxedTransport>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

This will only be called if the handler reponds true to Handler::has_upgrade and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.

impl<T: Template> IntoResponse for WebTemplate<T>

Available on crate feature axum-core-0.4 only.

fn into_response(self) -> Response

Create a response.

impl<T: Template> IntoResponse for WebTemplate<T>

Available on crate feature axum-core-0.5 only.

fn into_response(self) -> Response

Create a response.

impl<T: Template + Send> IntoResponse for WebTemplate<T>

Available on crate feature poem-3 only.

fn into_response(self) -> Response

Consume itself and return Response.

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>

where K: TryInto<HeaderName>, V: TryInto<HeaderValue>, Self: Sized,

Wrap an impl IntoResponse to add a header.

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>

where V: TryInto<HeaderValue>, Self: Sized,

Wrap an impl IntoResponse to with a new content type.

fn with_status(self, status: StatusCode) -> WithStatus<Self>

where Self: Sized,

Wrap an impl IntoResponse to set a status code.

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>

where Self: Sized,

Wrap an impl IntoResponse to set a body.

impl<T: Template> IntoResponse for WebTemplate<T>

Available on crate feature viz-core-0.10 only.

fn into_response(self) -> Response

Convert self to HTTP Response.

fn into_error(self) -> Error

Convert self to the Error.

impl<T: Template + Send> Reply for WebTemplate<T>

Available on crate feature warp-0.3 only.

fn into_response(self) -> Response

Converts the given value into a Response.

impl<'r, T: Template> Responder<'r, 'static> for WebTemplate<T>

Available on crate feature rocket-0.5 only.

fn respond_to(self, request: &'r Request<'_>) -> Result<'static>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.

impl<T: Template> Responder for WebTemplate<T>

Available on crate feature actix-web-4 only.

type Body = BoxBody

fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.

impl<T: Template> Scribe for WebTemplate<T>

Available on crate feature salvo_core-0.76 only.

fn render(self, res: &mut Response)

Render data to Response.

impl<T: Template> Scribe for WebTemplate<T>

Available on crate feature salvo_core-0.77 only.

fn render(self, res: &mut Response)

Render data to Response.

impl<T: Template> Scribe for WebTemplate<T>

Available on crate feature salvo_core-0.78 only.

fn render(self, res: &mut Response)

Render data to Response.

impl<T: Template> Template for WebTemplate<T>

const SIZE_HINT: usize = <T as Template>::SIZE_HINT

Provides a rough estimate of the expanded length of the rendered template. Larger values result in higher memory usage but fewer reallocations. Smaller values result in the opposite. This value only affects render. It does not take effect when calling render_into, write_into, the fmt::Display implementation, or the blanket ToString::to_string implementation.

fn render(&self) -> Result<String>

Helper method which allocates a new String and renders into it.

fn render_with_values(&self, values: &dyn Values) -> Result<String>

Helper method which allocates a new String and renders into it with provided Values.

fn render_into_with_values<W>( &self, writer: &mut W, values: &dyn Values, ) -> Result<()>

where W: Write + ?Sized,

Renders the template to the given writer fmt buffer with provided Values.

fn render_into<W: Write + ?Sized>(&self, writer: &mut W) -> Result<()>

Renders the template to the given writer fmt buffer.

fn write_into<W: Write + ?Sized>(&self, writer: &mut W) -> Result<()>

Renders the template to the given writer io buffer.

fn write_into_with_values<W: Write + ?Sized>( &self, writer: &mut W, values: &dyn Values, ) -> Result<()>

Renders the template to the given writer io buffer with provided Values.

impl<T: Copy + Template> Copy for WebTemplate<T>