Struct GetInstrumentsParams

Source

pub struct GetInstrumentsParams {
    pub inst_type: OKXInstrumentType,
    pub uly: Option<String>,
    pub inst_family: Option<String>,
    pub inst_id: Option<String>,
}

Expand description

Parameters for the GET /api/v5/public/instruments endpoint.

Fields§

§inst_type: OKXInstrumentType

Instrument type: SPOT, MARGIN, SWAP, FUTURES, OPTION.

§uly: Option<String>

Underlying. Only applicable to FUTURES/SWAP/OPTION. If instType is OPTION, either uly or instFamily is required.

§inst_family: Option<String>

Instrument family. Only applicable to FUTURES/SWAP/OPTION. If instType is OPTION, either uly or instFamily is required.

§inst_id: Option<String>

Instrument ID, e.g. BTC-USD-SWAP.

Trait Implementations§

Source §

impl Clone for GetInstrumentsParams

Source §

fn clone(&self) -> GetInstrumentsParams

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for GetInstrumentsParams

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for GetInstrumentsParams

Source §

fn default() -> GetInstrumentsParams

Returns the “default value” for a type. Read more

Source §

impl<'de> Deserialize<'de> for GetInstrumentsParams

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl Serialize for GetInstrumentsParams

Source §

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl UnwindSafe for GetInstrumentsParams

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§