Struct fred_rs::series::search::related_tags::Builder

pub struct Builder { /* fields omitted */ }

Methods

impl Builder

pub fn new() -> Builder

Initializes a new series::search::related_tags::Builder that can be used to add commands to an API request

The builder does not do validity checking of the arguments nor does it check for duplicates.

use fred_rs::series::search::related_tags::Builder;
// Create a new builder
let mut builder = Builder::new();
// add arguments to the builder
builder
    .realtime_start("1900-01-01")
    .realtime_end("2000-01-01");

pub fn realtime_start(&mut self, start_date: &str) -> &mut Builder

Adds a realtime_start argument to the builder

Arguments

• start_date - date formatted as YYYY-MM-DD

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#realtime_start

pub fn realtime_end(&mut self, end_date: &str) -> &mut Builder

Adds a realtime_end argument to the builder

Arguments

• end_date - date formatted as YYYY-MM-DD https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#realtime_end

pub fn tag_name(&mut self, tag: &str) -> &mut Builder

Adds a tag name to include in the search

Results must match all included tag names.

Arguments

• tag - tag name to add

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#tag_names

pub fn exclude_tag(&mut self, tag: &str) -> &mut Builder

Adds a tag name to exclude in the search

Results must match no excluded tag names.

Arguments

• tag - tag name to add

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#exclude_tag_names

pub fn tag_group_id(&mut self, id: TagGroupId) -> &mut Builder

Adds a group id filter to the results

Arguments

• id - type by which to filter results

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#tag_group_id

pub fn tag_search_text(&mut self, search_string: &str) -> &mut Builder

Add search string to find matching tags with

Arguments

• search_string - tag name to add

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#tag_search_text

pub fn limit(&mut self, num_results: usize) -> &mut Builder

Adds a limit argument to the builder

The limit argument specifies a maximum number of observations to return.

Arguments

• num_results - Maximum number of results to return

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#limit

pub fn offset(&mut self, ofs: usize) -> &mut Builder

Adds an offset argument to the builder

Adding an offset shifts the starting result number. For example, if limit is 5 and offset is 0 then results 1-5 will be returned, but if offset was 5 then results 6-10 would be returned.

Arguments

• ofs - the offset amount

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#offset

pub fn order_by(&mut self, order: OrderBy) -> &mut Builder

Specifies how to order results

Arguments

• order - result ranking system

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#order_by

pub fn sort_order(&mut self, order: SortOrder) -> &mut Builder

Change the sort order of the data

Arguments

• order - Data sort order enum

https://research.stlouisfed.org/docs/api/fred/series_search_related_tags.html#sort_order