Slippage

Struct Slippage 

Source
pub struct Slippage(/* private fields */);
Expand description

Type-safe slippage percentage with validation

Ensures slippage values are within valid ranges and provides convenient constructors for both percentage and basis point representations.

§Examples

use odos_sdk::Slippage;

// Create from percentage (0.5% slippage)
let slippage = Slippage::percent(0.5)?;
assert_eq!(slippage.as_percent(), 0.5);

// Create from basis points (50 bps = 0.5%)
let slippage = Slippage::bps(50)?;
assert_eq!(slippage.as_percent(), 0.5);
assert_eq!(slippage.as_bps(), 50);

// Validation prevents invalid values
assert!(Slippage::percent(150.0).is_err());  // > 100%
assert!(Slippage::percent(-1.0).is_err());   // < 0%
assert!(Slippage::bps(15000).is_err());      // > 10000 bps

Implementations§

Source§

impl Slippage

Source

pub const ZERO: Result<Self, &'static str>

Common slippage values for convenience

Source

pub fn percent(percent: f64) -> Result<Self, String>

Create slippage from percentage value

§Arguments
  • percent - Slippage as percentage (e.g., 0.5 for 0.5%, 1.0 for 1%)
§Returns
  • Ok(Slippage) - Valid slippage value
  • Err(String) - If percentage is < 0 or > 100
§Examples
use odos_sdk::Slippage;

let slippage = Slippage::percent(0.5)?;  // 0.5%
assert_eq!(slippage.as_percent(), 0.5);

let slippage = Slippage::percent(1.0)?;  // 1%
assert_eq!(slippage.as_percent(), 1.0);

// Validation
assert!(Slippage::percent(150.0).is_err());
assert!(Slippage::percent(-0.1).is_err());
Source

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

Create slippage from basis points

§Arguments
  • bps - Slippage in basis points (e.g., 50 for 0.5%, 100 for 1%)
§Returns
  • Ok(Slippage) - Valid slippage value
  • Err(String) - If basis points > 10000 (100%)
§Examples
use odos_sdk::Slippage;

let slippage = Slippage::bps(50)?;   // 50 bps = 0.5%
assert_eq!(slippage.as_bps(), 50);
assert_eq!(slippage.as_percent(), 0.5);

let slippage = Slippage::bps(100)?;  // 100 bps = 1%
assert_eq!(slippage.as_bps(), 100);
assert_eq!(slippage.as_percent(), 1.0);

// Validation
assert!(Slippage::bps(15000).is_err());
Source

pub fn as_percent(&self) -> f64

Get slippage value as percentage

§Examples
use odos_sdk::Slippage;

let slippage = Slippage::percent(0.5)?;
assert_eq!(slippage.as_percent(), 0.5);
Source

pub fn as_bps(&self) -> u16

Get slippage value as basis points

§Examples
use odos_sdk::Slippage;

let slippage = Slippage::percent(0.5)?;
assert_eq!(slippage.as_bps(), 50);

let slippage = Slippage::bps(100)?;
assert_eq!(slippage.as_bps(), 100);
Source

pub fn low() -> Self

0.1% slippage (10 basis points)

Source

pub fn standard() -> Self

0.5% slippage (50 basis points) - recommended for most swaps

Source

pub fn medium() -> Self

1% slippage (100 basis points)

Source

pub fn high() -> Self

3% slippage (300 basis points) - high slippage for volatile pairs

Trait Implementations§

Source§

impl Clone for Slippage

Source§

fn clone(&self) -> Slippage

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 Slippage

Source§

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

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

impl<'de> Deserialize<'de> for Slippage

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 Display for Slippage

Source§

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

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

impl From<Slippage> for f64

Source§

fn from(slippage: Slippage) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Slippage

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Slippage

Source§

fn partial_cmp(&self, other: &Slippage) -> 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

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

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

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

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

impl Serialize for Slippage

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
Source§

impl Copy for Slippage

Source§

impl StructuralPartialEq for Slippage

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> DynClone for T
where 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> 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> 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
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

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

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

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 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
Source§

impl<'de, T> BorrowedRpcObject<'de> for T
where T: RpcBorrow<'de> + RpcSend,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<'de, T> RpcBorrow<'de> for T
where T: Deserialize<'de> + Debug + Send + Sync + Unpin,

Source§

impl<T> RpcObject for T
where T: RpcSend + RpcRecv,

Source§

impl<T> RpcRecv for T
where T: DeserializeOwned + Debug + Send + Sync + Unpin + 'static,

Source§

impl<T> RpcSend for T
where T: Serialize + Clone + Debug + Send + Sync + Unpin,