pub struct LeverageToBase(/* private fields */);
Expand description
The absolute leverage for a position, in terms of the base asset.
Note that while leverage specified by the trader must be strictly positive (greater than 0), this type allows zero leverage to occur, since calculated leverage within the system based on the off-by-one exposure calculation may end up as 0.
Implementations§
§impl LeverageToBase
impl LeverageToBase
pub fn raw(self) -> Decimal256
pub fn raw(self) -> Decimal256
Get the raw underlying leverage value.
pub fn into_decimal256(self) -> Decimal256
pub fn into_decimal256(self) -> Decimal256
Convert to an unsigned decimal.
pub fn into_number(self) -> Signed<Decimal256>
pub fn into_number(self) -> Signed<Decimal256>
Convert to a signed decimal.
pub fn into_signed(self, direction: DirectionToBase) -> SignedLeverageToBase
pub fn into_signed(self, direction: DirectionToBase) -> SignedLeverageToBase
Convert into a SignedLeverageToBase
Trait Implementations§
§impl Clone for LeverageToBase
impl Clone for LeverageToBase
§fn clone(&self) -> LeverageToBase
fn clone(&self) -> LeverageToBase
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl Debug for LeverageToBase
impl Debug for LeverageToBase
§impl<'de> Deserialize<'de> for LeverageToBase
impl<'de> Deserialize<'de> for LeverageToBase
§fn deserialize<__D>(
__deserializer: __D
) -> Result<LeverageToBase, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>( __deserializer: __D ) -> Result<LeverageToBase, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl Display for LeverageToBase
impl Display for LeverageToBase
§impl From<NonZero<Decimal256>> for LeverageToBase
impl From<NonZero<Decimal256>> for LeverageToBase
§fn from(value: NonZero<Decimal256>) -> LeverageToBase
fn from(value: NonZero<Decimal256>) -> LeverageToBase
Converts to this type from the input type.
§impl FromStr for LeverageToBase
impl FromStr for LeverageToBase
§impl JsonSchema for LeverageToBase
impl JsonSchema for LeverageToBase
§fn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Returns a string that uniquely identifies the schema produced by this type. Read more
§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
§fn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the
$ref
keyword. Read more§impl Ord for LeverageToBase
impl Ord for LeverageToBase
§impl PartialEq for LeverageToBase
impl PartialEq for LeverageToBase
§fn eq(&self, other: &LeverageToBase) -> bool
fn eq(&self, other: &LeverageToBase) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.§impl PartialOrd for LeverageToBase
impl PartialOrd for LeverageToBase
§fn partial_cmp(&self, other: &LeverageToBase) -> Option<Ordering>
fn partial_cmp(&self, other: &LeverageToBase) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read more§impl Serialize for LeverageToBase
impl Serialize for LeverageToBase
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,
Serialize this value into the given Serde serializer. Read more
§impl TryFrom<&str> for LeverageToBase
impl TryFrom<&str> for LeverageToBase
impl Copy for LeverageToBase
impl Eq for LeverageToBase
impl StructuralEq for LeverageToBase
impl StructuralPartialEq for LeverageToBase
Auto Trait Implementations§
impl RefUnwindSafe for LeverageToBase
impl Send for LeverageToBase
impl Sync for LeverageToBase
impl Unpin for LeverageToBase
impl UnwindSafe for LeverageToBase
Blanket Implementations§
§impl<U> As for U
impl<U> As for U
§fn as_<T>(self) -> Twhere
T: CastFrom<U>,
fn as_<T>(self) -> Twhere T: CastFrom<U>,
Casts
self
to type T
. The semantics of numeric casting with the as
operator are followed, so <T as As>::as_::<U>
can be used in the same way as T as U
for numeric conversions. Read moresource§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> QueryResultExt for Twhere
T: Serialize,
impl<T> QueryResultExt for Twhere T: Serialize,
§fn query_result(&self) -> Result<Binary, Error>
fn query_result(&self) -> Result<Binary, Error>
Convert the value to its JSON representation