Struct MappingRequestBuilder 

pub struct MappingRequestBuilder { /* private fields */ }

Builder for constructing MappingRequest instances.

Provides a fluent API for setting identifier information and filter parameters. All methods return self to enable method chaining.

Required Fields

• id_type: Must be set via id_type()
• id_value: Must be set via id_value()

Examples

use openfigi_rs::model::request::MappingRequestBuilder;
use openfigi_rs::model::enums::{IdType, Currency, ExchCode};

let request = MappingRequestBuilder::new()
    .id_type(IdType::ID_ISIN)
    .id_value("US4592001014")
    .currency(Currency::USD)
    .exch_code(ExchCode::US)
    .build()
    .unwrap();

Implementations

impl MappingRequestBuilder

pub fn new() -> Self

Creates a new MappingRequestBuilder with all fields unset.

Examples

use openfigi_rs::model::request::MappingRequestBuilder;

let builder = MappingRequestBuilder::new();

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

Sets the identifier type for the mapping request.

This field is required and specifies what type of third-party identifier is being mapped to a FIGI.

Examples

use openfigi_rs::model::request::MappingRequestBuilder;
use openfigi_rs::model::enums::IdType;

let builder = MappingRequestBuilder::new().id_type(IdType::ID_ISIN);

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

Sets the identifier value for the mapping request.

This field is required and contains the actual identifier value to be mapped. Can accept strings, numbers, or any value that converts to serde_json::Value.

Examples

use openfigi_rs::model::request::MappingRequestBuilder;
use serde_json::json;

let builder = MappingRequestBuilder::new()
    .id_value("US4592001014")      // String
    .id_value(json!("AAPL"))       // JSON string
    .id_value(12345);              // Number

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

Mutable access to the request filters.

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 fn build(self) -> Result<MappingRequest>

Builds and validates the MappingRequest.

Constructs the final request object and performs validation to ensure all requirements are met.

Errors

Returns OpenFIGIError if validation fails, such as:

• Missing required fields (id_type or id_value)
• Missing security_type2 when required by identifier type
• Mutually exclusive parameters set
• Invalid parameter ranges

Examples

use openfigi_rs::model::request::MappingRequestBuilder;
use openfigi_rs::model::enums::IdType;

let request = MappingRequestBuilder::new()
    .id_type(IdType::ID_ISIN)
    .id_value("US4592001014")
    .build()
    .unwrap();

Trait Implementations

impl Default for MappingRequestBuilder

fn default() -> MappingRequestBuilder

Returns the “default value” for a type.