OrderBuilder

Struct OrderBuilder 

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

Order builder implementing a fluent API design.

Provides a type-safe and user-friendly way to construct orders.

§Examples

use ccxt_core::types::OrderSide;
use ccxt_core::types::order::OrderBuilder;
use rust_decimal_macros::dec;

// Create a limit buy order
let order = OrderBuilder::new("BTC/USDT".to_string(), OrderSide::Buy, dec!(0.1))
    .limit(dec!(50000))
    .client_order_id("my-order-123")
    .post_only()
    .build()
    .expect("valid order configuration");

// Create a market sell order
let order = OrderBuilder::new("ETH/USDT".to_string(), OrderSide::Sell, dec!(1.5))
    .market()
    .build()
    .expect("valid order configuration");

Implementations§

Source§

impl OrderBuilder

Source

pub fn new(symbol: String, side: OrderSide, amount: Decimal) -> OrderBuilder

Creates a new order builder instance.

§Arguments
  • symbol - Trading pair symbol (for example, “BTC/USDT”)
  • side - Order side (buy or sell)
  • amount - Order quantity
Source

pub fn limit(self, price: Decimal) -> OrderBuilder

Sets the builder to create a limit order.

Source

pub fn market(self) -> OrderBuilder

Sets the builder to create a market order.

Source

pub fn limit_maker(self, price: Decimal) -> OrderBuilder

Sets the builder to create a post-only limit order.

Source

pub fn stop_loss(self, stop_price: Decimal) -> OrderBuilder

Sets the builder to create a stop-loss order.

Source

pub fn stop_loss_limit( self, stop_price: Decimal, price: Decimal, ) -> OrderBuilder

Sets the builder to create a stop-loss limit order.

Source

pub fn take_profit(self, trigger_price: Decimal) -> OrderBuilder

Sets the builder to create a take-profit order.

Source

pub fn take_profit_limit( self, trigger_price: Decimal, price: Decimal, ) -> OrderBuilder

Sets the builder to create a take-profit limit order.

Source

pub fn stop_market(self, stop_price: Decimal) -> OrderBuilder

Sets the builder to create a stop-market order.

Source

pub fn stop_limit(self, stop_price: Decimal, price: Decimal) -> OrderBuilder

Sets the builder to create an alternative stop-limit order form.

Source

pub fn trailing_stop(self, callback_rate: Decimal) -> OrderBuilder

Sets the builder to create a trailing stop order.

Source

pub fn client_order_id(self, id: impl Into<String>) -> OrderBuilder

Sets the client order identifier.

Source

pub fn time_in_force(self, tif: TimeInForce) -> OrderBuilder

Sets the time-in-force policy.

Source

pub fn trigger_price(self, price: Decimal) -> OrderBuilder

Sets the trigger price.

Source

pub fn take_profit_price(self, price: Decimal) -> OrderBuilder

Sets the take-profit price.

Source

pub fn stop_loss_price(self, price: Decimal) -> OrderBuilder

Sets the stop-loss price.

Source

pub fn trailing_delta(self, delta: Decimal) -> OrderBuilder

Sets the trailing delta (in basis points).

Source

pub fn trailing_percent(self, percent: Decimal) -> OrderBuilder

Sets the trailing percentage.

Source

pub fn activation_price(self, price: Decimal) -> OrderBuilder

Sets the activation price.

Source

pub fn callback_rate(self, rate: Decimal) -> OrderBuilder

Sets the callback rate (used for futures trailing stops).

Source

pub fn working_type(self, wtype: impl Into<String>) -> OrderBuilder

Sets the working type (CONTRACT_PRICE or MARK_PRICE).

Source

pub fn post_only(self) -> OrderBuilder

Marks the order as post-only.

Source

pub fn reduce_only(self) -> OrderBuilder

Marks the order as reduce-only (used for futures).

Source

pub fn build(self) -> Result<Order, OrderBuilderError>

Validates the configuration and builds an Order.

Ensures the order configuration is valid. For example:

  • Limit orders require a price
  • Stop orders require a stop price
  • Quantities must be greater than zero
§Errors

Returns OrderBuilderError if the configuration is invalid.

Trait Implementations§

Source§

impl Clone for OrderBuilder

Source§

fn clone(&self) -> OrderBuilder

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 OrderBuilder

Source§

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

Formats the value using the given formatter. Read more

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: 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, 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