docs: document position (#89)

Co-authored-by: Wil Boayue <[email protected]>

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ibapi"
-version = "0.2.1"
+version = "0.2.2"
 edition = "2021"
 authors = ["Wil Boayue <[email protected]>"]
 description = "A synchronous implementation of the Interactive Brokers TWS API."

src/accounts.rs

@@ -10,9 +10,13 @@ mod encoders;
 
 #[derive(Debug, Default)]
 pub struct Position {
+    /// Account holding position
     pub account: String,
+    /// Contract
     pub contract: Contract,
+    /// Size of position
     pub position: f64,
+    /// Average cost of position
     pub average_cost: f64,
 }
 
@@ -39,7 +43,7 @@ pub(crate) fn cancel_positions(client: &Client) -> Result<(), Error> {
 }
 
 // Supports iteration over [Position].
-pub struct PositionIterator<'a> {
+pub(crate) struct PositionIterator<'a> {
     client: &'a Client,
     messages: GlobalResponseIterator,
 }

src/client.rs

@@ -211,7 +211,7 @@ impl Client {
 
     // === Accounts ===
 
-    /// Get current positions for all accessible accounts.
+    /// Get current [Position]s for all accessible accounts.
     #[allow(clippy::needless_lifetimes)]
     pub fn positions<'a>(&'a self) -> core::result::Result<impl Iterator<Item = Position> + 'a, Error> {
         accounts::positions(self)

src/lib.rs

@@ -103,7 +103,9 @@
 //! }
 //!```
 
-mod accounts;
+/// Describes items present in an account.
+pub mod accounts;
+
 /// TSW API Client.
 ///
 /// The Client establishes the connection to TWS or the Gateway.