Struct BasisPoints 

pub struct BasisPoints(/* private fields */);

A validated basis-points value in the inclusive range 0..=10_000.

Implementations

impl BasisPoints

pub const MAX: u16 = 10000

The maximum valid basis-points value (10000, equal to 100%).

pub fn new(bps: u16) -> Result<Self, BasisPointsError>

Creates a new BasisPoints after validating the input range.

Returns BasisPointsError::InvalidBasisPoints if bps > 10_000.

pub fn checked_add(self, rhs: Self) -> Option<Self>

Checked addition. Returns None if the result exceeds 10_000.

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Checked subtraction. Returns None if underflow occurs.

pub fn checked_mul(self, rhs: Self) -> Option<Self>

Checked multiplication. Returns None if the result exceeds 10_000.

pub fn checked_div(self, rhs: Self) -> Option<Self>

Checked division. Returns None on division-by-zero.

Trait Implementations

impl BorshDeserialize for BasisPoints

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for BasisPoints

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for BasisPoints

fn clone(&self) -> BasisPoints

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BasisPoints

impl Debug for BasisPoints

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

Formats the value using the given formatter.

impl Eq for BasisPoints

impl From<BasisPoints> for Decimal

Available on crate feature decimal only.

fn from(bps: BasisPoints) -> Self

Converts basis points to a proportional rate in 0..=1 (divide by 10_000).

impl From<BasisPoints> for u128

fn from(bps: BasisPoints) -> Self

Converts to this type from the input type.

impl From<BasisPoints> for u16

fn from(bps: BasisPoints) -> Self

Converts to this type from the input type.

impl From<BasisPoints> for u32

fn from(bps: BasisPoints) -> Self

Converts to this type from the input type.

impl From<BasisPoints> for u64

fn from(bps: BasisPoints) -> Self

Converts to this type from the input type.

impl IdlBuild for BasisPoints

fn create_type() -> Option<IdlTypeDef>

Create an IDL type definition for the type.

fn insert_types(types: &mut BTreeMap<String, IdlTypeDef>)

Insert all types that are included in the current type definition to the given map.

fn get_full_path() -> String

Get the full module path of the type.

impl PartialEq for BasisPoints

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Pod for BasisPoints

impl Space for BasisPoints

const INIT_SPACE: usize

impl StructuralPartialEq for BasisPoints

impl TryFrom<Decimal> for BasisPoints

Available on crate feature decimal only.

fn try_from(decimal: Decimal) -> Result<Self, Self::Error>

Converts a proportional rate in 0..=1 to basis points (multiply by 10_000).

Fractional results truncate toward zero when casting to u16.

type Error = BasisPointsError

The type returned in the event of a conversion error.

impl Zeroable for BasisPoints

fn zeroed() -> Self

Calls zeroed.