Struct Client 

pub struct Client { /* private fields */ }

A handle to a remote JSONRPC server

Implementations

impl Client

pub fn new<P: AsRef<Path>>(sockpath: P) -> Client

Creates a new client using the path to the socket file and initializing the timeout field to None

Examples found in repository

examples/lowlevel_1.rs (line 23)

fn main() {
    #[allow(deprecated)]
    let sock = env::home_dir().unwrap().join(".lightning/lightning-rpc");
    println!("Using socket {}", sock.display());
    let client = client::Client::new(&sock);
    let method = "getinfo";
    let params = GetInfoRequest {};
    match client
        .send_request(method, params)
        .and_then(|res: Response<GetInfoResponse>| res.into_result())
    {
        Ok(d) => {
            println!("Ok! {:?}", d);
        }
        Err(e) => {
            println!("Error! {}", e);
        }
    }
}

examples/lowlevel_2.rs (line 14)

fn main() {
    #[allow(deprecated)]
    let sock = env::home_dir().unwrap().join(".lightning/lightning-rpc");
    println!("Using socket {}", sock.display());
    let client = client::Client::new(&sock);
    for style in &["perkb", "perkw"] {
        let method = "feerates";
        let params = json!({
            "style": style,
        });
        match client
            .send_request(method, params)
            .and_then(|res: types::Response<HashMap<String, Value>>| res.into_result())
        {
            Ok(d) => {
                println!("Ok! {:?}", d);
            }
            Err(e) => {
                println!("Error! {}", e);
            }
        }
    }
}

pub fn set_timeout(&mut self, timeout: Option<Duration>)

Set an optional timeout for requests

pub fn send_request<S: Serialize, D: DeserializeOwned>( &self, method: &str, params: S, ) -> Result<Response<D>, Error>

Sends a request to a client

Examples found in repository

examples/lowlevel_1.rs (line 27)

fn main() {
    #[allow(deprecated)]
    let sock = env::home_dir().unwrap().join(".lightning/lightning-rpc");
    println!("Using socket {}", sock.display());
    let client = client::Client::new(&sock);
    let method = "getinfo";
    let params = GetInfoRequest {};
    match client
        .send_request(method, params)
        .and_then(|res: Response<GetInfoResponse>| res.into_result())
    {
        Ok(d) => {
            println!("Ok! {:?}", d);
        }
        Err(e) => {
            println!("Error! {}", e);
        }
    }
}

examples/lowlevel_2.rs (line 21)

fn main() {
    #[allow(deprecated)]
    let sock = env::home_dir().unwrap().join(".lightning/lightning-rpc");
    println!("Using socket {}", sock.display());
    let client = client::Client::new(&sock);
    for style in &["perkb", "perkw"] {
        let method = "feerates";
        let params = json!({
            "style": style,
        });
        match client
            .send_request(method, params)
            .and_then(|res: types::Response<HashMap<String, Value>>| res.into_result())
        {
            Ok(d) => {
                println!("Ok! {:?}", d);
            }
            Err(e) => {
                println!("Error! {}", e);
            }
        }
    }
}

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.