Struct dropshot::RequestContext

pub struct RequestContext<Context: ServerContext> {
    pub server: Arc<DropshotState<Context>>,
    pub path_variables: BTreeMap<String, VariableValue>,
    pub body_content_type: ApiEndpointBodyContentType,
    pub request_id: String,
    pub log: Logger,
    pub request: RequestInfo,
}

Handle for various interfaces useful during request processing.

Fields

server: Arc<DropshotState<Context>>

shared server state

path_variables: BTreeMap<String, VariableValue>

HTTP request routing variables

body_content_type: ApiEndpointBodyContentType

expected request body mime type

request_id: String

unique id assigned to this request

log: Logger

logger for this specific request

request: RequestInfo

basic request information (method, URI, etc.)

Implementations

impl<Context: ServerContext> RequestContext<Context>

pub fn context(&self) -> &Context

Returns the server context state.

pub fn page_limit<ScanParams, PageSelector>( &self, pag_params: &PaginationParams<ScanParams, PageSelector> ) -> Result<NonZeroU32, HttpError>

where ScanParams: DeserializeOwned, PageSelector: DeserializeOwned + Serialize,

Returns the appropriate count of items to return for a paginated request

This first looks at any client-requested limit and clamps it based on the server-configured maximum page size. If the client did not request any particular limit, this function returns the server-configured default page size.

Trait Implementations

impl<Context: Debug + ServerContext> Debug for RequestContext<Context>

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

Formats the value using the given formatter.

impl<T: 'static + ServerContext> RequestContextArgument for RequestContext<T>

type Context = T