Struct django_query::mock::NestedEndpoint

pub struct NestedEndpoint<T> { /* private fields */ }

A Django nested route.

A nested route in Django is a way of specifying that a particular filter field must be present when querying for a particular object type, and that it the filter type must be exact match. So for example, if all objects of type Foo have a reference to a Bar, and its too expensive or undesirable to query for Foos without specifying which Bar they come from, then you can express this in Django as a nested route:

http://example.com/bars/my-bar-id/foos

where in order to ask any question about Foos you must first identify a particular associated Bar.

Since the django-query crate operates on query parameters, the simplest way to handle this is to use a UrlTransform to convert any relevant parts of the path into query parameters as required, which is all this type does. It is otherwise identical to Endpoint.

Implementations

impl<T, R> NestedEndpoint<T> where
    T: Send + Sync + RowSource<Item = R>,
    R: Filterable + Sortable + 'static,
    <T as RowSource>::Rows: Deref,
    for<'a> &'a <<T as RowSource>::Rows as Deref>::Target: IntoIterator<Item = &'a R>, 

pub fn new(
    transform: UrlTransform,
    row_source: T,
    base_uri: Option<&str>
) -> Self

Create a new NestedEndpoint.

The given UrlTransform will be applied to every incoming request. The row_source will be used to gather the data to respond to the rewritten request.

Trait Implementations

impl<T, R> Respond for NestedEndpoint<T> where
    T: Send + Sync + RowSource<Item = R>,
    R: Filterable + Sortable + IntoRow + 'static,
    <T as RowSource>::Rows: Deref,
    for<'a> &'a <<T as RowSource>::Rows as Deref>::Target: IntoIterator<Item = &'a R>, 

fn respond(&self, request: &Request) -> ResponseTemplate

Given a reference to a Request return a ResponseTemplate that will be used by the MockServer as blueprint for the response returned to the client.