Struct FilterData 

pub struct FilterData {
    pub data: Vec<FigiResult>,
    pub next: Option<String>,
    pub total: Option<usize>,
}

Successful filter result data containing FIGI results and pagination metadata.

This structure represents the payload of a successful filter request, containing the actual FIGI data along with pagination information. The filter endpoint can return large result sets, so pagination is supported through the next token.

Field Descriptions

• data: Array of FIGI results matching the filter criteria
• next: Optional pagination token for retrieving the next page of results
• total: Total number of results available (across all pages)

Pagination

When the result set is large, the API may return only a subset of results along with a next token. This token can be used in subsequent requests to retrieve additional pages of results.

Fields

data: Vec<FigiResult>

Array of FIGI results matching the filter criteria.

Each element contains detailed information about a financial instrument that matches the submitted filter parameters. The array may be empty if no instruments match the criteria.

next: Option<String>

Pagination token for retrieving the next page of results.

This field is present when there are more results available beyond the current page. Use this token in subsequent filter requests to retrieve additional results.

total: Option<usize>

Total number of results available across all pages.

This count represents the complete result set size, not just the number of results in the current page. Useful for implementing pagination controls and progress indicators.

Implementations

impl FilterData

pub fn data(&self) -> &[FigiResult]

Returns a slice of the FIGI results contained in this mapping response.

Provides access to the financial instrument data returned for the mapping request.

pub fn next_page(&self) -> Option<&str>

Returns the pagination token for retrieving the next page of results.

Returns Some(token) if more results are available, None if this is the last page. The token can be used in subsequent search requests to continue pagination.

pub fn total_results(&self) -> Option<&usize>

Returns the total number of results available across all pages.

The filter endpoint almost always provides the total count, so this method returns Some(total) rather than None.

Trait Implementations

impl Clone for FilterData

fn clone(&self) -> FilterData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilterData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FilterData

fn eq(&self, other: &FilterData) -> 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 FilterData

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 FilterData