View

Struct View 

Source
pub struct View<T> { /* private fields */ }
Expand description

A response that renders a template with a context

This is the primary way to render HTML templates in RustAPI handlers.

§Example

use rustapi_view::{View, Templates};
use serde::Serialize;

#[derive(Serialize)]
struct HomeContext {
    title: String,
}

async fn home(templates: State<Templates>) -> View<HomeContext> {
    View::render(&templates, "home.html", HomeContext {
        title: "Home".to_string(),
    })
}

Implementations§

Source§

impl<T: Serialize> View<T>

Source

pub async fn render(templates: &Templates, template: &str, context: T) -> Self

Create a view by rendering a template with a serializable context

This is an async operation that renders the template immediately. For deferred rendering, use View::deferred.

Source

pub async fn render_with_status( templates: &Templates, template: &str, context: T, status: StatusCode, ) -> Self

Create a view with a specific status code

Source

pub fn from_html(html: impl Into<String>) -> Self

Create a view from pre-rendered HTML

Source

pub fn error(err: ViewError) -> Self

Create an error view

Source

pub fn status(self, status: StatusCode) -> Self

Set the status code

Source§

impl View<()>

Source

pub async fn render_context( templates: &Templates, template: &str, context: &Context, ) -> Self

Create a view by rendering a template with a tera Context

Source§

impl<T: Serialize> View<T>

Helper for creating views with different status codes

Source

pub async fn not_found( templates: &Templates, template: &str, context: T, ) -> Self

Create a 404 Not Found view

Source

pub async fn forbidden( templates: &Templates, template: &str, context: T, ) -> Self

Create a 403 Forbidden view

Source

pub async fn unauthorized( templates: &Templates, template: &str, context: T, ) -> Self

Create a 401 Unauthorized view

Trait Implementations§

Source§

impl<T> IntoResponse for View<T>

Source§

fn into_response(self) -> Response<Full<Bytes>>

Convert self into a Response
Source§

impl<T> ResponseModifier for View<T>

Source§

fn update_response(op: &mut Operation)

Update the operation with response information

Auto Trait Implementations§

§

impl<T> Freeze for View<T>

§

impl<T> !RefUnwindSafe for View<T>

§

impl<T> Send for View<T>
where T: Send,

§

impl<T> Sync for View<T>
where T: Sync,

§

impl<T> Unpin for View<T>
where T: Unpin,

§

impl<T> !UnwindSafe for View<T>

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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