Struct SeriesSearchRequest 

pub struct SeriesSearchRequest<'a> { /* private fields */ }

A builder for a series/search request, returned by Client::search.

Only parameters you set are sent; anything left unset uses FRED’s default. Finish with send.

use ferric_fred::{OrderBy, SortOrder};
let results = client
    .search("unemployment rate")
    .order_by(OrderBy::Popularity)
    .sort_order(SortOrder::Descending)
    .limit(10)
    .send()
    .await?;
println!("{} total matches", results.count);

Implementations

impl<'a> SeriesSearchRequest<'a>

pub fn search_type(self, search_type: SearchType) -> Self

How the search text is interpreted (search_type).

pub fn order_by(self, order_by: OrderBy) -> Self

Field to order results by (order_by).

pub fn sort_order(self, order: SortOrder) -> Self

Sort order of the results (sort_order).

pub fn limit(self, limit: u32) -> Self

Maximum number of results to return, 1..=1000 (limit).

pub fn offset(self, offset: u32) -> Self

Number of results to skip from the start (offset), for paging.

pub async fn send(self) -> Result<SeriesSearchResults>

Run the search and return the matching series with pagination metadata.

Errors

Returns an error if the request fails to send, FRED returns a non-success status, or the response body cannot be deserialized.

Trait Implementations

impl<'a> Clone for SeriesSearchRequest<'a>

fn clone(&self) -> SeriesSearchRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SeriesSearchRequest<'a>

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

Formats the value using the given formatter.

impl Paginate for SeriesSearchRequest<'_>

const MAX_PAGE: u32 = 1000

FRED’s maximum page size for this endpoint — the largest limit it honors. 1000 for most lists; 10000 for release dates and vintage dates.

type Page = SeriesSearchResults

The page type this request returns.

fn requested_limit(&self) -> Option<u32>

The caller’s requested limit, if set. send_all treats it as a ceiling on the total number of items returned.

fn requested_offset(&self) -> Option<u32>

The caller’s requested offset, if set — the point send_all starts paging from.

fn with_paging(self, limit: u32, offset: u32) -> Self

Return a copy of this request with limit and offset set.

fn send_page(self) -> impl Future<Output = Result<Self::Page>> + Send

Send a single page — equivalent to the builder’s own send.

fn send_all( self, ) -> impl Future<Output = Result<Vec<<Self::Page as Page>::Item>>> + Send

Fetch every result across all pages, in order.

fn stream(self) -> impl Stream<Item = Result<<Self::Page as Page>::Item>> + Send

Stream every result across all pages, lazily — items are yielded as they arrive, and the next page is fetched only once the current one is drained.