Skip to main content

EndpointCall

Struct EndpointCall 

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

Genuine logical endpoint data available to hooks and application callbacks.

Clones share trusted session state, observed snapshots and queued headers. Every public dispatch constructs fresh state; supplied HTTP metadata cannot carry a caller-populated virtual principal into this context.

Implementations§

Source§

impl EndpointCall

Source

pub fn new( definition: &EndpointDefinition, body: Option<JsValue>, query: Option<JsValue>, options: EndpointOptions, ) -> Self

Source

pub fn from_http_request(request: &AuthRequest, route: &AuthRoute) -> Self

Logical HTTP endpoint input after physical routing and body parsing. The original physical request remains separate from normalized hook input.

Source

pub fn operation_id(&self) -> &str

Source

pub fn path(&self) -> Option<&str>

Source

pub const fn method(&self) -> Option<&HttpMethod>

Source

pub const fn body(&self) -> Option<&JsValue>

Source

pub const fn query(&self) -> Option<&JsValue>

Source

pub fn with_params_value(self, params: JsValue) -> Self

Retain supplied logical parameters in every genuine callback frame.

Source

pub const fn params(&self) -> Option<&JsValue>

Source

pub const fn headers(&self) -> Option<&HashMap<String, String>>

Source

pub fn replace_headers(&mut self, headers: HashMap<String, String>)

Replace logical headers after a physical/plugin header transformation. Session state and the distinct physical Request are retained.

Source

pub const fn request(&self) -> Option<&AuthRequest>

Source

pub const fn phase(&self) -> EndpointPhase

Source

pub fn has_body(&self) -> bool

Source

pub fn has_query(&self) -> bool

Source

pub fn has_method(&self) -> bool

Source

pub fn middleware_context(&self) -> Self

Middleware callbacks have their own path/query defaults; matchers retain raw input.

Source

pub fn handler_context( &self, body: Option<JsValue>, query: Option<JsValue>, ) -> Self

A handler receives validated data and its registered method/path defaults.

Source

pub const fn extensions(&self) -> &RequestExtensions

Source

pub const fn default_method(&self) -> &HttpMethod

Source

pub fn virtual_session(&self) -> Option<SessionView>

Source

pub fn establish_session<S: AuthSchema>( &self, user: S::User, user_view: UserView, session: SessionView, context: &AuthContext<S>, )

Retain the actual model and snapshot after a trusted hook has authenticated them. This is an application/plugin authority boundary, never client input.

Source

pub fn session(&self) -> Option<(UserView, SessionView)>

Callback-visible authenticated data. This observation does not confer authority.

Source

pub fn record_authenticated_session(&self, user: UserView, session: SessionView)

Source

pub fn authenticated_user<S: AuthSchema>( &self, context: &AuthContext<S>, ) -> Option<S::User>

Source

pub fn set_response_header( &self, name: impl Into<String>, value: impl Into<String>, )

Source

pub fn queue_response_header( &self, name: impl Into<String>, value: impl Into<String>, )

Source

pub fn take_response_headers(&self) -> Headers

Source

pub fn set_session_hook_snapshot(&self, user: UserView, session: SessionView)

Source

pub fn session_hook_snapshot(&self) -> Option<(UserView, SessionView)>

Source

pub fn body_as<T: DeserializeOwned + 'static>(&self) -> AuthResult<T>

§Errors

Returns a typed decoding error for the current, post-hook body.

Source

pub fn query_as<T: DeserializeOwned + 'static>(&self) -> AuthResult<T>

§Errors

Returns a typed decoding error for the current, post-hook query.

Trait Implementations§

Source§

impl Clone for EndpointCall

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EndpointCall

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SessionRequest for EndpointCall

Source§

fn physical_request(&self) -> Option<&AuthRequest>

The original physical request, when the caller supplied one.
Source§

fn endpoint_call(&self) -> Option<&EndpointCall>

Retain a genuine logical endpoint call when this input has one.
Source§

fn session_headers(&self) -> &HashMap<String, String>

Source§

fn session_method(&self) -> &HttpMethod

Source§

fn session_query_truthy(&self, name: &str) -> bool

Source§

fn extensions(&self) -> &RequestExtensions

Source§

fn virtual_session<S: AuthSchema>( &self, context: &AuthContext<S>, ) -> Option<SessionView>

Source§

fn authenticated_user<S: AuthSchema>( &self, context: &AuthContext<S>, ) -> Option<S::User>

Source§

fn take_response_headers(&self) -> Headers

Source§

fn queue_response_header( &self, name: impl Into<String>, value: impl Into<String>, )

Source§

fn set_session_hook_snapshot(&self, user: UserView, session: SessionView)

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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