Skip to content

Commit e26b9cb

Browse files
committed
Minor documentation update.
1 parent 75034bc commit e26b9cb

File tree

3 files changed

+36
-8
lines changed

3 files changed

+36
-8
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
config.toml
22
commit_msg
3-
.DS_STORE
3+
.DS_Store
4+
**/.DS_Store
45

56
target/
67
configs/

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ readme = "README.md"
88
homepage = "https://github.com/Ohkthx/cbadv-rs"
99
repository = "https://github.com/Ohkthx/cbadv-rs"
1010
keywords = ["trading", "coinbase", "coinbasepro", "coinbaseadvanced", "crypto"]
11-
categories = ["api-bindings", "cryptocurrency"]
11+
categories = ["api-bindings", "cryptography::cryptocurrencies"]
1212
include = ["src/**", "Cargo.toml", "README.md", "LICENSE", "examples/**"]
1313

1414
[features]

src/models/order/builders.rs

+33-6
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ impl OrderCreateBuilder {
4444
/// # Example
4545
///
4646
/// ```rust
47+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
4748
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
4849
/// ```
4950
pub fn new(product_id: &str, side: &OrderSide) -> Self {
@@ -77,6 +78,8 @@ impl OrderCreateBuilder {
7778
/// # Example
7879
///
7980
/// ```rust
81+
/// use cbadv::order::{OrderCreateBuilder, OrderSide, OrderType};
82+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
8083
/// builder.order_type(OrderType::Limit);
8184
/// ```
8285
pub fn order_type(mut self, order_type: OrderType) -> Self {
@@ -89,10 +92,10 @@ impl OrderCreateBuilder {
8992
/// Time-in-force specifies how long an order remains active before it is executed or expires.
9093
/// Common values include:
9194
///
92-
/// - `GTC` (Good 'til Cancelled): The order remains active until it is filled or canceled.
93-
/// - `GTD` (Good 'til Date): The order remains active until a specified date and time.
94-
/// - `IOC` (Immediate or Cancel): The order must be executed immediately; otherwise, any unfilled portion is canceled.
95-
/// - `FOK` (Fill or Kill): The order must be filled entirely immediately; otherwise, it is canceled.
95+
/// - `GoodUntilCancelled`: The order remains active until it is filled or canceled.
96+
/// - `GoodUntilDateTime`: The order remains active until a specified date and time.
97+
/// - `ImmediateOrCancel`: The order must be executed immediately; otherwise, any unfilled portion is canceled.
98+
/// - `FillOrKill`: The order must be filled entirely immediately; otherwise, it is canceled.
9699
///
97100
/// # Arguments
98101
///
@@ -101,7 +104,9 @@ impl OrderCreateBuilder {
101104
/// # Example
102105
///
103106
/// ```rust
104-
/// builder.time_in_force(TimeInForce::GTC);
107+
/// use cbadv::order::{OrderCreateBuilder, OrderSide, TimeInForce};
108+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
109+
/// builder.time_in_force(TimeInForce::GoodUntilCancelled);
105110
/// ```
106111
pub fn time_in_force(mut self, tif: TimeInForce) -> Self {
107112
self.time_in_force = Some(tif);
@@ -124,6 +129,8 @@ impl OrderCreateBuilder {
124129
/// # Example
125130
///
126131
/// ```rust
132+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
133+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
127134
/// builder.base_size(0.5); // Buying or selling 0.5 BTC
128135
/// ```
129136
pub fn base_size(mut self, base_size: f64) -> Self {
@@ -148,6 +155,8 @@ impl OrderCreateBuilder {
148155
/// # Example
149156
///
150157
/// ```rust
158+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
159+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
151160
/// builder.quote_size(1000.0); // Spending $1000 USD to buy BTC
152161
/// ```
153162
pub fn quote_size(mut self, quote_size: f64) -> Self {
@@ -173,6 +182,8 @@ impl OrderCreateBuilder {
173182
/// # Example
174183
///
175184
/// ```rust
185+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
186+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
176187
/// builder.limit_price(50000.0); // Limit price of $50,000 per BTC
177188
/// ```
178189
pub fn limit_price(mut self, limit_price: f64) -> Self {
@@ -197,6 +208,8 @@ impl OrderCreateBuilder {
197208
/// # Example
198209
///
199210
/// ```rust
211+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
212+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
200213
/// builder.stop_price(48000.0); // Trigger the order when the price reaches $48,000
201214
/// ```
202215
pub fn stop_price(mut self, stop_price: f64) -> Self {
@@ -221,6 +234,8 @@ impl OrderCreateBuilder {
221234
/// # Example
222235
///
223236
/// ```rust
237+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
238+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
224239
/// builder.stop_trigger_price(47000.0); // Exit the position when the price reaches $47,000
225240
/// ```
226241
pub fn stop_trigger_price(mut self, stop_trigger_price: f64) -> Self {
@@ -244,6 +259,8 @@ impl OrderCreateBuilder {
244259
/// # Example
245260
///
246261
/// ```rust
262+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
263+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
247264
/// builder.end_time("2024-12-31T23:59:59Z");
248265
/// ```
249266
pub fn end_time(mut self, end_time: &str) -> Self {
@@ -268,6 +285,8 @@ impl OrderCreateBuilder {
268285
/// # Example
269286
///
270287
/// ```rust
288+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
289+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
271290
/// builder.post_only(true);
272291
/// ```
273292
pub fn post_only(mut self, post_only: bool) -> Self {
@@ -293,6 +312,8 @@ impl OrderCreateBuilder {
293312
/// # Example
294313
///
295314
/// ```rust
315+
/// use cbadv::order::{OrderCreateBuilder, OrderSide, StopDirection};
316+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
296317
/// builder.stop_direction(StopDirection::StopUp);
297318
/// ```
298319
pub fn stop_direction(mut self, stop_direction: StopDirection) -> Self {
@@ -317,6 +338,8 @@ impl OrderCreateBuilder {
317338
/// # Example
318339
///
319340
/// ```rust
341+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
342+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
320343
/// builder.client_order_id("my-custom-order-id-123");
321344
/// ```
322345
pub fn client_order_id(mut self, client_order_id: &str) -> Self {
@@ -337,6 +360,8 @@ impl OrderCreateBuilder {
337360
/// # Example
338361
///
339362
/// ```rust
363+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
364+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
340365
/// builder.preview(true);
341366
/// ```
342367
pub fn preview(mut self, is_preview: bool) -> Self {
@@ -363,7 +388,9 @@ impl OrderCreateBuilder {
363388
/// # Example
364389
///
365390
/// ```rust
366-
/// let create_order = builder.build()?;
391+
/// use cbadv::order::{OrderCreateBuilder, OrderSide};
392+
/// let builder = OrderCreateBuilder::new("BTC-USD", &OrderSide::Buy);
393+
/// let create_order = builder.build();
367394
/// ```
368395
pub fn build(self) -> CbResult<OrderCreateRequest> {
369396
if self.side == OrderSide::Unknown {

0 commit comments

Comments
 (0)