Struct FilterRequest 

pub struct FilterRequest {
    pub query: Option<String>,
    pub start: Option<String>,
    pub filters: RequestFilters,
}

Request structure for the OpenFIGI /filter endpoint.

Represents a filter request that can include search keywords and various filtering criteria. At least one of query or a filter parameter must be specified for a valid request.

Fields

• query: Optional search keywords for finding instruments
• start: Optional pagination token for retrieving subsequent pages
• filters: Additional filtering criteria (flattened into the request JSON)

Examples

use openfigi_rs::model::request::FilterRequest;
use openfigi_rs::model::enums::Currency;

// Simple query-based filter
let request = FilterRequest::builder()
    .query("IBM")
    .build()
    .unwrap();

// Filter with additional criteria
let request = FilterRequest::builder()
    .query("technology stocks")
    .currency(Currency::USD)
    .build()
    .unwrap();

Fields

query: Option<String>

Filter keywords for finding FIGIs.

start: Option<String>

Pagination token for retrieving subsequent result pages.

When more results are available, the response contains a next property whose value should be sent in succeeding requests as the start value to retrieve the next “page” of results.

filters: RequestFilters

Additional filtering criteria applied to the mapping request.

These filters are flattened into the JSON structure and provide optional constraints to refine the mapping results see RequestFilters.

Implementations

impl FilterRequest

pub fn new() -> Self

Creates a new empty FilterRequest.

All fields are initialized to None or default values. Use FilterRequest::builder() for a more convenient fluent API.

Examples

use openfigi_rs::model::request::FilterRequest;

let request = FilterRequest::new();
assert!(request.query.is_none());

pub fn builder() -> FilterRequestBuilder

Creates a new FilterRequestBuilder for fluent request construction.

Provides a convenient way to build filter requests with method chaining.

Examples

use openfigi_rs::model::request::FilterRequest;
use openfigi_rs::model::enums::Currency;

let request = FilterRequest::builder()
    .query("AAPL")
    .currency(Currency::USD)
    .build()
    .unwrap();

pub fn validate(&self) -> Result<()>

Validates the filter request.

Ensures that:

• At least one field (query or filter) is specified
• All filter validation rules are satisfied
• No mutually exclusive parameters are set
• Numeric and date ranges are valid

Errors

Returns OpenFIGIError with OtherErrorKind::Validation if validation fails.

Examples

use openfigi_rs::model::request::FilterRequest;

let request = FilterRequest::new();
assert!(request.validate().is_err()); // No fields set

let request = FilterRequest::builder()
    .query("IBM")
    .build()
    .unwrap();
assert!(request.validate().is_ok());

Trait Implementations

impl Clone for FilterRequest

fn clone(&self) -> FilterRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterRequest

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

Formats the value using the given formatter.

impl Default for FilterRequest

fn default() -> FilterRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FilterRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FilterRequest

fn eq(&self, other: &FilterRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FilterRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FilterRequest