Skip to main content

MarketDataService

Trait MarketDataService 

Source
pub trait MarketDataService:
    Send
    + Sync
    + 'static {
    // Required methods
    fn get_trades<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetTradesRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetTradesResponse> + Send + use<'a, Self>>> + Send;
    fn get_candles<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetCandlesRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetCandlesResponse> + Send + use<'a, Self>>> + Send;
    fn get_candles_columns<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetCandlesColumnsRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetCandlesColumnsResponse> + Send + use<'a, Self>>> + Send;
    fn get_spot_config<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetSpotConfigRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetSpotConfigResponse> + Send + use<'a, Self>>> + Send;
}
Expand description

Server trait for MarketDataService.

§Implementing handlers

Implement methods with plain async fn; the returned future satisfies the Send bound automatically.

Unary and server-streaming requests arrive as ServiceRequest<'_, Req>: a zero-copy view of the request plus its body, valid for the duration of the call. Fields are read directly (request.name is a &str into the decoded buffer) and the borrow may be held across .await points. Anything that must outlive the call — tokio::spawn, channels, server state, or data captured by a returned response stream — takes owned data: call request.to_owned_message() (or copy the specific fields) first.

Client-streaming and bidi requests arrive as InboundStream<Req> — a ServiceStream of StreamMessages. Each item owns its decoded buffer and is Send + 'static, so items can be buffered or moved into spawned tasks; read fields zero-copy through the generated accessor methods (item.name()) or .view(), convert with .to_owned_message(), or yield an item back unchanged — StreamMessage<M> implements Encodable<M>.

Request types resolved through extern_path (e.g. well-known types from another crate) use the same wrappers; the crate that owns the type must be generated with buffa ≥ 0.8.0 and views enabled so the backing HasMessageView impl exists.

The impl Encodable<Out> return bound accepts the owned Out, the generated OutView<'_> / OwnedOutView, MaybeBorrowed, or PreEncoded for handlers that encode a non-'static view internally and pass the bytes across the handler boundary. View bodies are not emitted for output types mapped via extern_path (the impl would be an orphan); return owned for WKT/extern outputs.

Server-streaming and bidi-streaming methods return ServiceStream<impl Encodable<Out> + Send + use<Self>>. The use<Self> precise-capturing clause excludes &self’s lifetime and the request’s lifetime (unary methods use use<'a, Self> and may borrow from &self), so stream items must be 'static and cannot borrow from the request. To stream view-encoded data, encode each item inside the stream body and yield PreEncoded — see its # Streaming example doc.

Required Methods§

Source

fn get_trades<'a>( &'a self, ctx: RequestContext, request: ServiceRequest<'_, GetTradesRequest>, ) -> impl Future<Output = ServiceResult<impl Encodable<GetTradesResponse> + Send + use<'a, Self>>> + Send

Retrieve recent public trades for a spot market. Results are ordered newest-first and support optional aggressor side, inclusive time-range, and opaque keyset pagination filters.

'a lets the response body borrow from &self (e.g. server-resident state).

request is borrowed from the request body and is valid for the duration of the call; message fields are read directly on it (zero-copy). The response cannot borrow from request — use .to_owned_message() (or copy the specific fields) for anything returned, stored, or moved into tokio::spawn.

Source

fn get_candles<'a>( &'a self, ctx: RequestContext, request: ServiceRequest<'_, GetCandlesRequest>, ) -> impl Future<Output = ServiceResult<impl Encodable<GetCandlesResponse> + Send + use<'a, Self>>> + Send

Retrieve OHLCV candles for a spot market and timeframe. Results are ordered newest-first and support inclusive time bounds, optional current open candle inclusion, and optional composite reference candles.

'a lets the response body borrow from &self (e.g. server-resident state).

request is borrowed from the request body and is valid for the duration of the call; message fields are read directly on it (zero-copy). The response cannot borrow from request — use .to_owned_message() (or copy the specific fields) for anything returned, stored, or moved into tokio::spawn.

Source

fn get_candles_columns<'a>( &'a self, ctx: RequestContext, request: ServiceRequest<'_, GetCandlesColumnsRequest>, ) -> impl Future<Output = ServiceResult<impl Encodable<GetCandlesColumnsResponse> + Send + use<'a, Self>>> + Send

GetCandlesColumns returns OHLCV candles in a columnar representation optimized for charting. This method is intended for ConnectRPC clients and returns scaled integers: OHLC prices use 1e6 quote-unit scale, and volumes use base_quantity_scale.

'a lets the response body borrow from &self (e.g. server-resident state).

request is borrowed from the request body and is valid for the duration of the call; message fields are read directly on it (zero-copy). The response cannot borrow from request — use .to_owned_message() (or copy the specific fields) for anything returned, stored, or moved into tokio::spawn.

Source

fn get_spot_config<'a>( &'a self, ctx: RequestContext, request: ServiceRequest<'_, GetSpotConfigRequest>, ) -> impl Future<Output = ServiceResult<impl Encodable<GetSpotConfigResponse> + Send + use<'a, Self>>> + Send

Retrieve a cacheable snapshot of spot assets and pairs, including precision and trading constraints.

'a lets the response body borrow from &self (e.g. server-resident state).

request is borrowed from the request body and is valid for the duration of the call; message fields are read directly on it (zero-copy). The response cannot borrow from request — use .to_owned_message() (or copy the specific fields) for anything returned, stored, or moved into tokio::spawn.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§