Skip to main content

Params

Struct Params 

Source
pub struct Params { /* private fields */ }
Expand description

Extra exchange-specific parameters for a unified call.

Build with Params::new and the with_* setters, or Params::none when a method needs no extras. Cheap to clone and Default-constructible.

Implementations§

Source§

impl Params

Source

pub fn new() -> Self

An empty parameter set.

Source

pub fn none() -> Self

An empty parameter set — reads better at a call site than Params::new() when you are explicitly passing “no extras”.

Source

pub fn is_empty(&self) -> bool

true when nothing has been set.

Source

pub fn len(&self) -> usize

Number of parameters set.

Source

pub fn with_str(self, key: &str, value: &str) -> Self

Set a string parameter.

Source

pub fn with_int(self, key: &str, value: i64) -> Self

Set an integer parameter.

Source

pub fn with_float(self, key: &str, value: f64) -> Self

Set a floating-point parameter.

Source

pub fn with_bool(self, key: &str, value: bool) -> Self

Set a boolean parameter.

Source

pub fn with_strs(self, key: &str, values: &[&str]) -> Self

Set a list-of-strings parameter (e.g. a batch of client order ids).

Source

pub fn with_json(self, key: &str, json: &str) -> Self

Set a nested parameter from a JSON literal, for the rare venue that wants a structured object. Invalid JSON is stored as a plain string.

Source

pub fn with_params(self, key: &str, value: Params) -> Self

Set a nested object from another Params. Calling this twice with the same key MERGES — the second call adds to the object rather than replacing it.

Source

pub fn into_value_object(self) -> Value

Like Params::into_value but an empty set stays an empty object rather than collapsing to Value::Null — used when nesting, where the key should still exist.

Source

pub fn into_value(self) -> Value

Lower to the dynamic representation the transpiled core consumes. An empty set becomes Value::Null, which every unified method treats as “no extra params”.

Trait Implementations§

Source§

impl Clone for Params

Source§

fn clone(&self) -> Params

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Params

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Params

Source§

fn default() -> Params

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

impl From<()> for Params

() reads as “no extra params” at a call site.

Source§

fn from(_: ()) -> Params

Converts to this type from the input type.
Source§

impl From<Params> for Value

Source§

fn from(p: Params) -> Value

Converts to this type from the input type.
Source§

impl From<Value> for Params

Back-compat: existing call sites that already hold a Value (including Value::Null) keep working without a conversion at the call site.

Source§

fn from(v: Value) -> Params

Converts to this type from the input type.
Source§

impl<const N: usize> From<[(&str, &str); N]> for Params

Source§

fn from(pairs: [(&str, &str); N]) -> Params

Converts to this type from the input type.
Source§

impl PartialEq for Params

Source§

fn eq(&self, other: &Params) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Params

Auto Trait Implementations§

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.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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<U> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more