Struct SingleMappingRequestBuilder 

pub struct SingleMappingRequestBuilder { /* private fields */ }

Builder for constructing single mapping requests to the /mapping endpoint.

Provides a fluent API for configuring mapping request parameters and executing requests. Created via OpenFIGIClient::mapping with required ID type and value parameters.

Examples

use openfigi_rs::client::OpenFIGIClient;
use openfigi_rs::model::enums::{IdType, Currency};
use serde_json::json;

let client = OpenFIGIClient::new();

let response = client
    .mapping(IdType::ID_ISIN, json!("US4592001014"))
    .currency(Currency::USD)
    .send()
    .await?;

Implementations

impl SingleMappingRequestBuilder

pub fn id_type(self, id_type: IdType) -> Self

Sets the required ID type for the mapping request.

pub fn id_value<T: Into<Value>>(self, id_value: T) -> Self

Sets the required ID value for the mapping request.

pub fn filters_mut(&mut self) -> &mut RequestFilters

Mutable access to the request filters, delegating to the inner MappingRequestBuilder.

pub fn exch_code(self, exch_code: ExchCode) -> Self

Sets the exch_code for the desired instrument.

pub fn mic_code(self, mic_code: MicCode) -> Self

Sets the mic_code for the desired instrument.

pub fn currency(self, currency: Currency) -> Self

Sets the currency for the desired instrument.

pub fn market_sec_des(self, market_sec_des: MarketSecDesc) -> Self

Sets the market_sec_des for the desired instrument.

pub fn security_type(self, security_type: SecurityType) -> Self

Sets the security_type for the desired instrument.

pub fn security_type2(self, security_type2: SecurityType2) -> Self

Sets the security_type2 for the desired instrument.

pub fn include_unlisted_equities(self, val: bool) -> Self

Sets whether to include unlisted equities in the filter.

pub fn option_type(self, option_type: OptionType) -> Self

Sets the option_type for the desired instrument.

pub fn strike(self, strike: [Option<f64>; 2]) -> Self

Sets the strike price range for the desired instrument.

pub fn contract_size(self, contract_size: [Option<f64>; 2]) -> Self

Sets the contract_size range for the desired instrument.

pub fn coupon(self, coupon: [Option<f64>; 2]) -> Self

Sets the coupon range for the desired instrument.

pub fn expiration(self, expiration: [Option<NaiveDate>; 2]) -> Self

Sets the expiration date range for the desired instrument.

pub fn maturity(self, maturity: [Option<NaiveDate>; 2]) -> Self

Sets the maturity date range for the desired instrument.

pub fn state_code(self, state_code: StateCode) -> Self

Sets the state_code for the desired instrument.

pub async fn send_raw(self) -> Result<Response>

Sends the mapping request to /mapping endpoint and returns the raw HTTP response.

This is useful when you need access to headers, status codes, or want to handle the response parsing yourself.

Errors

Returns an crate::error::OpenFIGIError if the mapping request is invalid or if the HTTP request fails.

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

Sends the mapping request to /mapping endpoint and returns parsed results.

Errors

Returns an crate::error::OpenFIGIError if the mapping request is invalid, if the HTTP request fails, or if the response cannot be parsed.