Struct RequestBuilder

pub struct RequestBuilder<'a, S: RequestState> { /* private fields */ }

Struct implementing the builder & typestate patterns for creating a request

Implementations

impl<'a, S: RequestState> RequestBuilder<'a, S>

pub fn done(self) -> Request<'a>

Drop the builder and extract the finished request.

pub fn match_type(self, match_type: MatchType) -> Self

Set the match type of the request

pub fn match_prefix(self) -> Self

Shorthand for match_type(MatchType::Prefix)

pub fn output(self, output: Output) -> Self

Set the output format of the request

pub fn with_filter(self, filter: Filter<'a>) -> Self

Add a filter to be applied to the whole set of entries before any grouping takes place

Normal filters are requirements, inverted filters exclude matching results.

pub fn filter(self, field: Field, regex: &'a str) -> Self

Shorthand for with_filter(Filter::new(...))

pub fn filter_inverted(self, field: Field, regex: &'a str) -> Self

Shorthand for with_filter(Filter::inverted(...))

impl<'a> RequestBuilder<'a, BasicRequest>

pub fn new(url: &'a str) -> Self

Create a new basic request

pub fn with_field(self, field: Field) -> Self

Explicitly add a Field to the list of fields in the result.

Fields can be added multiple times. When no field is added to a request, the server chooses a default set of fields

pub fn collapse(self, field: Field) -> RequestBuilder<'a, GroupedRequest>

Collapse the result set by grouping entries for which the given field has the same value.

This is generally used to group results by UrlKey

impl<'a> RequestBuilder<'a, GroupedRequest>

pub fn with_field<F: RequestField>(self, field: F) -> Self

Explicitly add a Field or GroupField to the list of fields in the result.

Fields can be added multiple times. When no field is added to a request, the server chooses a default set of fields