Trait LedgerReadService 

pub trait LedgerReadService:
    Send
    + Sync
    + 'static {
    // Required methods
    fn get_balance_history<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetBalanceHistoryRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetBalanceHistoryResponse> + Send + use<'a, Self>>> + Send;
    fn get_equity_history_series<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetEquityHistorySeriesRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetEquityHistorySeriesResponse> + Send + use<'a, Self>>> + Send;
    fn list_transfers<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, ListTransfersRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<ListTransfersResponse> + Send + use<'a, Self>>> + Send;
    fn list_holds<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, ListHoldsRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<ListHoldsResponse> + Send + use<'a, Self>>> + Send;
    fn get_balances<'a>(
        &'a self,
        ctx: RequestContext,
        request: ServiceRequest<'_, GetBalancesRequest>,
    ) -> impl Future<Output = ServiceResult<impl Encodable<GetBalancesResponse> + Send + use<'a, Self>>> + Send;
}

LedgerReadService exposes read-only ledger endpoints (balances, history, transfers, holds).

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

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

Retrieve balance history buckets for an account. Supports optional subaccount, range, asset, and account-code 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.

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

Retrieve equity history as columnar series data. Supports optional subaccount, range, account-code filtering, and grouping by account or asset.

'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.

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

List finalized transfer history for an account. Supports optional subaccount, asset, ordering, and cursor 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.

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

ListHolds returns pending holds with integer amounts (u128) and asset ids.

'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.

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

Retrieve the latest balances for an account. Supports optional subaccount scoping and returns asset symbols with decimal amounts on REST.

'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