Skip to main content

ApiRequest

dbrest_core::api_request

Struct ApiRequest

pub struct ApiRequest {Show 15 fields
    pub action: Action,
    pub ranges: HashMap<CompactString, Range>,
    pub top_level_range: Range,
    pub payload: Option<Payload>,
    pub preferences: Preferences,
    pub query_params: QueryParams,
    pub columns: HashSet<CompactString>,
    pub headers: Vec<(String, String)>,
    pub cookies: Vec<(String, String)>,
    pub path: String,
    pub method: String,
    pub schema: CompactString,
    pub negotiated_by_profile: bool,
    pub accept_media_types: Vec<MediaType>,
    pub content_media_type: MediaType,
}

Expand description

The core API request struct.

The core ApiRequest data type. Contains all parsed and validated information from an HTTP request.

Fields§

§action: Action

The resolved action to perform

§ranges: HashMap<CompactString, Range>

Ranges keyed by embed level (e.g., “limit” for top-level)

§top_level_range: Range

The top-level range for the main query

§payload: Option<Payload>

Parsed request body

§preferences: Preferences

Parsed Prefer headers

§query_params: QueryParams

Parsed query parameters

§columns: HashSet<CompactString>

Column names from payload or &columns parameter

§headers: Vec<(String, String)>

HTTP headers (lowercased name, value)

§cookies: Vec<(String, String)>

Request cookies

§path: String

Raw request path

§method: String

HTTP method

§schema: CompactString

The request schema (from profile headers or default)

§negotiated_by_profile: bool

Whether the schema was negotiated via profile headers

§accept_media_types: Vec<MediaType>

Accepted media types from Accept header (sorted by quality)

§content_media_type: MediaType

Content-Type of the request body

Trait Implementations§

impl Clone for ApiRequest

fn clone(&self) -> ApiRequest

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ApiRequest

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !Freeze for ApiRequest

impl RefUnwindSafe for ApiRequest

impl Send for ApiRequest

impl Sync for ApiRequest

impl Unpin for ApiRequest

impl UnsafeUnpin for ApiRequest

impl UnwindSafe for ApiRequest

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more