Struct apca::Client

pub struct Client { /* private fields */ }

A Client is the entity used by clients of this module for interacting with the Alpaca API.

Implementations

impl Client

pub fn builder() -> Builder

Instantiate a new Builder which allows for creating a customized Client.

pub fn new(api_info: ApiInfo) -> Self

Create a new Client using the given key ID and secret for connecting to the API.

pub fn issue<R>( &self, input: &R::Input ) -> impl Future<Output = Result<R::Output, RequestError<R::Error>>> + '_where R: Endpoint,

Create and issue a request and decode the response.

pub async fn subscribe<S>(&self) -> Result<(S::Stream, S::Subscription), Error>where S: Subscribable<Input = ApiInfo>,

Subscribe to the given subscribable in order to receive updates.

Notes

• this method is only a short-hand for S::connect that supplies the client’s ApiInfo object to the call; if your Subscribable requires a different input then invoke its connect method yourself

pub fn api_info(&self) -> &ApiInfo

Retrieve the ApiInfo object used by this Client instance.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.