Struct SearchRequest 

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

Request structure for the OpenFIGI /search endpoint.

Represents a search request that finds FIGIs using keywords and filters. Requires a search query with optional filtering criteria and pagination support.

Required Fields

• query: Search keywords for finding FIGIs

Optional Fields

• start: Pagination token for retrieving subsequent pages
• filters: Additional filtering criteria (flattened into the request JSON)

Examples

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

// Simple keyword search
let request = SearchRequest::new("IBM");

// Search with additional filters
let request = SearchRequest::builder()
    .query("technology")
    .currency(Currency::USD)
    .build()
    .unwrap();

Fields

query: String

Search 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 SearchRequest

pub fn new(query: impl Into<String>) -> Self

Creates a new SearchRequest with required search keywords.

All filter fields are initialized to their default values (typically None). Use SearchRequest::builder() for a more convenient fluent API.

Arguments

• query - Search keywords for FIGIs

Examples

use openfigi_rs::model::request::SearchRequest;

let request = SearchRequest::new("IBM");
assert_eq!(request.query, "IBM");

pub fn builder() -> SearchRequestBuilder

Creates a new SearchRequestBuilder for fluent request construction.

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

Examples

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

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

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

Validates the search request.

Ensures that:

• 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::SearchRequest;

let request = SearchRequest::new("IBM");
assert!(request.validate().is_ok());

Trait Implementations

impl Clone for SearchRequest

fn clone(&self) -> SearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchRequest

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

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 SearchRequest