Skip to main content

Context

Struct Context 

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

Per-request context passed to every action.

Implementations§

Source§

impl Context

Source

pub async fn build(req: Request) -> Self

Central constructor used by the #[controller] macro. Splits the request, captures matched path params, and retains the body for later reads.

Source

pub fn from_request_parts(parts: Parts) -> Self

Source

pub fn from_request(parts: Parts, body: Body) -> Self

Source

pub fn db(&self) -> &'static DatabaseConnection

The application’s database connection (global pool installed at boot).

Source

pub fn param(&self, name: &str) -> Option<&str>

A matched path parameter by name, e.g. ctx.param("id") for /posts/{id}.

Source

pub async fn form<T: DeserializeOwned>(&mut self) -> Result<T>

Deserialize a URL-encoded (form) request body. Consumes the body.

Source

pub async fn body_json<T: DeserializeOwned>(&mut self) -> Result<T>

Deserialize a JSON request body. Consumes the body.

Source

pub fn params<T: DeserializeOwned>(&self) -> Result<T>

Deserialize typed params from the request URI query string.

Source

pub fn query_params(&self) -> Params

The query string as strong Params, for require/permit allowlisting before use.

Source

pub fn render(&self, template: &str, data: Value) -> Response

Render a Tera view to an HTML 200 response.

template is resolved by the global doido_view engine (installed at boot) against app/views, with the .html.tera suffix added — e.g. "posts/index"app/views/posts/index.html.tera. A render failure (or an uninitialised engine) yields a 500.

Source

pub fn json<T: Serialize>(&self, data: T) -> Response

Return a JSON 200 response.

Source

pub fn redirect_to(&self, location: impl AsRef<str>) -> Response

Return a 302 redirect.

Source

pub fn status(&self, code: u16) -> Response

Return a response with an explicit status code and empty body. code must be a valid HTTP status code (100–999).

Source

pub fn header(&self, name: &str) -> Option<&HeaderValue>

Get a request header by name (lowercase).

Source

pub fn send_data( &self, data: Vec<u8>, content_type: &str, filename: Option<&str>, ) -> Response

Send raw bytes as a response (Rails send_data). When filename is set, a Content-Disposition: attachment header prompts a download.

Source

pub async fn send_file( &self, path: impl AsRef<Path>, content_type: Option<&str>, ) -> Result<Response>

Send a file’s contents as a response (Rails send_file). content_type defaults to application/octet-stream; the file name is used for the download disposition.

Source

pub fn negotiated_format(&self) -> Format

The negotiated response Format: a .json or .html path extension wins, otherwise the Accept header is inspected; anything else is Any.

Source

pub fn respond_to(&self) -> RespondTo

Begin format-based content negotiation (Rails respond_to).

Source

pub fn etag_matches(&self, etag: &str) -> bool

Whether the request’s If-None-Match matches etag (or is *).

Source

pub fn fresh_when( &self, etag: Option<&str>, last_modified: Option<&str>, ) -> Option<Response>

HTTP conditional-GET check (Rails fresh_when): if the request’s validators match etag (If-None-Match) or last_modified (If-Modified-Since), return a 304 Not Modified echoing the validators; otherwise return None and render normally (setting the same validators).

Source

pub fn cookies(&mut self) -> &mut CookieJar

The plain/signed cookie jar (Rails cookies / cookies.signed). Reads parse the request Cookie header; staged writes are flushed to Set-Cookie after the action runs (see commit_to_response).

Source

pub fn session(&mut self) -> &mut Session

The encrypted session (Rails session). Loaded from the session cookie on first access and re-encrypted into the response afterwards.

Source

pub fn flash(&mut self) -> &mut Flash

The flash (Rails flash): messages set on one request and read on the next. Messages set this request are carried forward in a cookie; a flash that is only read is swept so it lives exactly one following request.

Source

pub fn commit_to_response(&self, response: &mut Response)

Flush any session/flash/cookie changes into the response Set-Cookie headers. Called by the #[controller] macro after the action; a no-op when the action never touched session/flash/cookies.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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