pub struct Peer(/* private fields */);
Implementations§
Source§impl Peer
impl Peer
Sourcepub async fn connect(
socket_addr: SocketAddr,
connector: Connector,
options: PeerOptions,
) -> Result<(Peer, Receiver<Message>), ClientError>
pub async fn connect( socket_addr: SocketAddr, connector: Connector, options: PeerOptions, ) -> Result<(Peer, Receiver<Message>), ClientError>
Connects to a peer using its IP address and port.
Sourcepub async fn connect_full_uri(
uri: &str,
connector: Connector,
options: PeerOptions,
) -> Result<(Peer, Receiver<Message>), ClientError>
pub async fn connect_full_uri( uri: &str, connector: Connector, options: PeerOptions, ) -> Result<(Peer, Receiver<Message>), ClientError>
Connects to a peer using its full websocket URI.
For example, wss://127.0.0.1:8444/ws
.
Sourcepub fn from_websocket(
ws: WebSocketStream<MaybeTlsStream<TcpStream>>,
options: PeerOptions,
) -> Result<(Peer, Receiver<Message>), ClientError>
pub fn from_websocket( ws: WebSocketStream<MaybeTlsStream<TcpStream>>, options: PeerOptions, ) -> Result<(Peer, Receiver<Message>), ClientError>
Creates a peer from an existing websocket connection. The connection must be secured with TLS, so that the certificate can be hashed in a peer id.
Sourcepub fn socket_addr(&self) -> SocketAddr
pub fn socket_addr(&self) -> SocketAddr
The IP address and port of the peer connection.
pub async fn send_transaction( &self, spend_bundle: SpendBundle, ) -> Result<TransactionAck, ClientError>
pub async fn request_puzzle_state( &self, puzzle_hashes: Vec<BytesImpl<32>>, previous_height: Option<u32>, header_hash: BytesImpl<32>, filters: CoinStateFilters, subscribe_when_finished: bool, ) -> Result<Result<RespondPuzzleState, RejectPuzzleState>, ClientError>
pub async fn request_coin_state( &self, coin_ids: Vec<BytesImpl<32>>, previous_height: Option<u32>, header_hash: BytesImpl<32>, subscribe: bool, ) -> Result<Result<RespondCoinState, RejectCoinState>, ClientError>
pub async fn register_for_ph_updates( &self, puzzle_hashes: Vec<BytesImpl<32>>, min_height: u32, ) -> Result<RespondToPhUpdates, ClientError>
pub async fn register_for_coin_updates( &self, coin_ids: Vec<BytesImpl<32>>, min_height: u32, ) -> Result<RespondToCoinUpdates, ClientError>
pub async fn remove_puzzle_subscriptions( &self, puzzle_hashes: Option<Vec<BytesImpl<32>>>, ) -> Result<RespondRemovePuzzleSubscriptions, ClientError>
pub async fn remove_coin_subscriptions( &self, coin_ids: Option<Vec<BytesImpl<32>>>, ) -> Result<RespondRemoveCoinSubscriptions, ClientError>
pub async fn request_transaction( &self, transaction_id: BytesImpl<32>, ) -> Result<RespondTransaction, ClientError>
pub async fn request_puzzle_and_solution( &self, coin_id: BytesImpl<32>, height: u32, ) -> Result<Result<PuzzleSolutionResponse, RejectPuzzleSolution>, ClientError>
pub async fn request_children( &self, coin_id: BytesImpl<32>, ) -> Result<RespondChildren, ClientError>
pub async fn request_peers(&self) -> Result<RespondPeers, ClientError>
Sourcepub async fn send<T>(&self, body: T) -> Result<(), ClientError>where
T: Streamable + ChiaProtocolMessage,
pub async fn send<T>(&self, body: T) -> Result<(), ClientError>where
T: Streamable + ChiaProtocolMessage,
Sends a message to the peer, but does not expect any response.
Sourcepub async fn request_fallible<T, E, B>(
&self,
body: B,
) -> Result<Result<T, E>, ClientError>where
T: Streamable + ChiaProtocolMessage,
E: Streamable + ChiaProtocolMessage,
B: Streamable + ChiaProtocolMessage,
pub async fn request_fallible<T, E, B>(
&self,
body: B,
) -> Result<Result<T, E>, ClientError>where
T: Streamable + ChiaProtocolMessage,
E: Streamable + ChiaProtocolMessage,
B: Streamable + ChiaProtocolMessage,
Sends a message to the peer and expects a message that’s either a response or a rejection.
Sourcepub async fn request_infallible<T, B>(&self, body: B) -> Result<T, ClientError>
pub async fn request_infallible<T, B>(&self, body: B) -> Result<T, ClientError>
Sends a message to the peer and expects a specific response message.
Sourcepub async fn request_raw<T>(&self, body: T) -> Result<Message, ClientError>where
T: Streamable + ChiaProtocolMessage,
pub async fn request_raw<T>(&self, body: T) -> Result<Message, ClientError>where
T: Streamable + ChiaProtocolMessage,
Sends a message to the peer and expects any arbitrary protocol message without parsing it.
pub async fn close(&self) -> Result<(), ClientError>
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Peer
impl !RefUnwindSafe for Peer
impl Send for Peer
impl Sync for Peer
impl Unpin for Peer
impl !UnwindSafe for Peer
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.