Struct lightning_block_sync::rpc::RpcClient
source · [−]pub struct RpcClient { /* private fields */ }
rpc-client
only.Expand description
A simple RPC client for calling methods using HTTP POST
.
Implementations
sourceimpl RpcClient
impl RpcClient
sourcepub fn new(credentials: &str, endpoint: HttpEndpoint) -> Result<Self>
pub fn new(credentials: &str, endpoint: HttpEndpoint) -> Result<Self>
Creates a new RPC client connected to the given endpoint with the provided credentials. The credentials should be a base64 encoding of a user name and password joined by a colon, as is required for HTTP basic access authentication.
Trait Implementations
sourceimpl BlockSource for RpcClient
impl BlockSource for RpcClient
sourcefn get_header<'a>(
&'a self,
header_hash: &'a BlockHash,
_height: Option<u32>
) -> AsyncBlockSourceResult<'a, BlockHeaderData>
fn get_header<'a>(
&'a self,
header_hash: &'a BlockHash,
_height: Option<u32>
) -> AsyncBlockSourceResult<'a, BlockHeaderData>
Returns the header for a given hash. A height hint may be provided in case a block source cannot easily find headers based on a hash. This is merely a hint and thus the returned header must have the same hash as was requested. Otherwise, an error must be returned. Read more
sourcefn get_block<'a>(
&'a self,
header_hash: &'a BlockHash
) -> AsyncBlockSourceResult<'a, Block>
fn get_block<'a>(
&'a self,
header_hash: &'a BlockHash
) -> AsyncBlockSourceResult<'a, Block>
Returns the block for a given hash. A headers-only block source should return a Transient
error. Read more
sourcefn get_best_block<'a>(
&'a self
) -> AsyncBlockSourceResult<'a, (BlockHash, Option<u32>)>
fn get_best_block<'a>(
&'a self
) -> AsyncBlockSourceResult<'a, (BlockHash, Option<u32>)>
Returns the hash of the best block and, optionally, its height. Read more
Auto Trait Implementations
impl !RefUnwindSafe for RpcClient
impl Send for RpcClient
impl Sync for RpcClient
impl Unpin for RpcClient
impl !UnwindSafe for RpcClient
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more