pub struct NonZero<T>(/* private fields */);
Expand description

Ensure that the inner value is never 0.

Implementations§

§

impl<T> NonZero<T>where T: UnsignedDecimal,

pub fn inverse(self) -> NonZero<T>

Get the multiplicative inverse.

Guaranteed not to fail, since all values here must be great than zero.

§

impl<T> NonZero<T>where T: UnsignedDecimal,

pub fn to_be_bytes(&self) -> [u8; 32]

Convert into a big-endian array.

pub fn from_be_bytes(bytes: [u8; 32]) -> Option<NonZero<T>>

Convert raw bytes into this value.

Intended for use with cw-storage-plus.

pub fn raw(self) -> T

Get the underlying raw value.

pub fn into_signed(self) -> Signed<T>

Turn into a signed value.

pub fn new(src: T) -> Option<NonZero<T>>

Try to convert a raw value into a NonZero.

pub fn into_decimal256(self) -> Decimal256

Convert into a general purpose Decimal256.

pub fn into_number_gt_zero(self) -> NonZero<Decimal256>

Convert into NonZero<Decimal>

pub fn into_number(self) -> Signed<Decimal256>

Convert into a general purpose Number.

pub fn try_from_number(src: Signed<Decimal256>) -> Option<NonZero<T>>

Try to convert a general purpose Number into this type.

pub fn try_from_decimal(src: Decimal256) -> Option<NonZero<T>>

Try to convert a general purpose Decimal256 into this type.

pub fn try_from_signed(src: Signed<T>) -> Result<NonZero<T>, Error>

Try to convert a signed value into a non-zero.

pub fn checked_add(self, rhs: T) -> Result<NonZero<T>, Error>

Add an unsigned value to this non-zero

This can fail due to overflow error, but is guaranteed to not give a value of 0.

pub fn checked_sub(self, rhs: T) -> Result<NonZero<T>, Error>

Subtract an unsigned value.

This can fail if the result would be either negative or zero.

pub fn checked_add_signed(self, rhs: Signed<T>) -> Result<NonZero<T>, Error>

Try to add a signed value to this, erroring if it results in a negative or zero result.

pub fn checked_sub_signed(self, rhs: Signed<T>) -> Result<NonZero<T>, Error>

Try to subtract a signed value from this, erroring if it results in a negative or zero result.

pub fn one() -> NonZero<T>

The value 1.

§

impl NonZero<Collateral>

pub fn checked_mul_non_zero( self, rhs: NonZero<Decimal256> ) -> Result<NonZero<Collateral>, Error>

Multiply by the given non-zero decimal.

pub fn checked_div_collateral( self, rhs: NonZero<Collateral> ) -> Result<NonZero<Decimal256>, Error>

Divide two non-zero collateral values to get the ratio between them.

This can be used for cases like calculating the max gains.

Trait Implementations§

§

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

§

fn clone(&self) -> NonZero<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<T> Debug for NonZero<T>where T: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<'de, T> Deserialize<'de> for NonZero<T>where T: UnsignedDecimal,

§

fn deserialize<D>( deserializer: D ) -> Result<NonZero<T>, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl<T> Display for NonZero<T>where T: UnsignedDecimal,

§

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

Formats the value using the given formatter. Read more
§

impl From<NonZero<Decimal256>> for LeverageToBase

§

fn from(value: NonZero<Decimal256>) -> LeverageToBase

Converts to this type from the input type.
§

impl<T> From<NonZero<T>> for Signed<T>where T: UnsignedDecimal,

§

fn from(src: NonZero<T>) -> Signed<T>

Converts to this type from the input type.
§

impl<T> FromStr for NonZero<T>where T: UnsignedDecimal,

§

type Err = Error

The associated error which can be returned from parsing.
§

fn from_str(s: &str) -> Result<NonZero<T>, <NonZero<T> as FromStr>::Err>

Parses a string s to return a value of this type. Read more
§

impl<T> JsonSchema for NonZero<T>where T: UnsignedDecimal,

§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
§

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
§

impl<T> Ord for NonZero<T>where T: Ord,

§

fn cmp(&self, other: &NonZero<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl<T> PartialEq for NonZero<T>where T: PartialEq,

§

fn eq(&self, other: &NonZero<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<T> PartialOrd for NonZero<T>where T: PartialOrd,

§

fn partial_cmp(&self, other: &NonZero<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl<T> Serialize for NonZero<T>where T: UnsignedDecimal,

§

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<T> TryFrom<&str> for NonZero<T>where T: UnsignedDecimal,

§

type Error = Error

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

fn try_from( value: &str ) -> Result<NonZero<T>, <NonZero<T> as TryFrom<&str>>::Error>

Performs the conversion.
§

impl<T> TryFrom<Signed<T>> for NonZero<T>where T: UnsignedDecimal,

§

type Error = Error

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

fn try_from( value: Signed<T> ) -> Result<NonZero<T>, <NonZero<T> as TryFrom<Signed<T>>>::Error>

Performs the conversion.
§

impl<T> TryFrom<u128> for NonZero<T>where T: UnsignedDecimal,

§

type Error = Error

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

fn try_from( val: u128 ) -> Result<NonZero<T>, <NonZero<T> as TryFrom<u128>>::Error>

Performs the conversion.
§

impl<T> TryFrom<u64> for NonZero<T>where T: UnsignedDecimal,

§

type Error = Error

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

fn try_from(val: u64) -> Result<NonZero<T>, <NonZero<T> as TryFrom<u64>>::Error>

Performs the conversion.
§

impl<T> Copy for NonZero<T>where T: Copy,

§

impl<T> Eq for NonZero<T>where T: Eq,

§

impl<T> StructuralEq for NonZero<T>

§

impl<T> StructuralPartialEq for NonZero<T>

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for NonZero<T>where T: RefUnwindSafe,

§

impl<T> Send for NonZero<T>where T: Send,

§

impl<T> Sync for NonZero<T>where T: Sync,

§

impl<T> Unpin for NonZero<T>where T: Unpin,

§

impl<T> UnwindSafe for NonZero<T>where T: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for 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 more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> QueryResultExt for Twhere T: Serialize,

§

fn query_result(&self) -> Result<Binary, Error>

Convert the value to its JSON representation
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,