Struct stellar_client::client::sync::Client

pub struct Client { /* fields omitted */ }

A client that can issue requests to a horizon api in a synchronous fashion, meaning that the functions will block until the response has been formed. The overall performance of this is slightly slower than using async but will generally be simpler to implement.

Methods

impl Client

pub fn new(uri: &str) -> Result<Self>

Constructs a new stellar synchronous client.

Examples

use stellar_client::sync::Client;
let client = Client::new("https://horizon-testnet.stellar.org").unwrap();

pub fn horizon_test() -> Result<Self>

Constructs a new stellar client connected to the horizon test network.

Examples

use stellar_client::sync::Client;
let client = Client::horizon_test().unwrap();

pub fn is_horizon_test(&self) -> bool

Returns true if this is a test client.

Examples

let client = Client::horizon_test().unwrap();
assert!(!client.is_horizon());
assert!(client.is_horizon_test());

pub fn horizon() -> Result<Self>

Constructs a new stellar client connected to the horizon prod network.

Examples

use stellar_client::sync::Client;
let client = Client::horizon().unwrap();

pub fn is_horizon(&self) -> bool

Returns true if this is a horizon@stellar client.

Examples

let client = Client::horizon().unwrap();
assert!(client.is_horizon());
assert!(!client.is_horizon_test());

pub fn request<E>(&self, endpoint: E) -> Result<E::Response> where     E: IntoRequest,

Issues a request to the stellar horizon server synchronously.

Examples

use stellar_client::sync::Client;
use stellar_client::endpoint::account;
let client = Client::horizon_test().unwrap();
let endpoint =
    account::Details::new("GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ");
let account = client.request(endpoint).unwrap();
assert_eq!(account.id(), "GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ");

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.