Module stellar_client::endpoint [] [src]

This module contains the various end point definitions for stellar's horizon API server. An endpoint is a struct that implement the IntoRequest trait and can be given to a client for fetching into a response.

Example

use stellar_client::sync::Client;
use stellar_client::endpoint::transaction;

// Instantiate a client connected to the horizon test network
let client = Client::horizon_test().unwrap();

// Create a struct that represents the "all" transactions endpoint
let txns = transaction::All::default();

// Give the endpoint to the client and receive back a `Records` struct
// that provides the resulting set of transactions
let all_txns = client.request(txns).unwrap();

Modules

account

Contains endpoints for accessing accounts and related information.

asset

Contains endpoints for assets and related information to specific assets.

effect

Contains the endpoint for all effects.

ledger

Contains the endpoint for all ledgers.

operation

Contains the endpoint for all operations.

orderbook

Contains the endpoint for fetching the orderbook for a given asset pair

payment

Contains the endpoint for all payment operations.

trade

Contains the endpoint for all trades.

transaction

Contains endpoints for transactions and related information.

Structs

ParseDirectionError

When a bad token or string is provided to parsing into a direction you get an error.

Records

A struct that represents a set of records returned from the horizon api.

Enums

Body

Represents the body of a request to an IntoRequest.

Direction

The order to return results in.

Traits

Cursor

Declares that this endpoint has a cursor and can have it set.

IntoRequest

Declares the definition of a stellar endpoint and the return type.

Limit

Declares that this endpoint has a limit and can have it set.

Order

Declares that this endpoint has an order field and can have it set.