pub struct Websocket {
pub stream: Option<WebSocketStream<MaybeTlsStream<TcpStream>>>,
pub channels: HashMap<u64, Channel>,
pub url: String,
}
Fields§
§stream: Option<WebSocketStream<MaybeTlsStream<TcpStream>>>
§channels: HashMap<u64, Channel>
§url: String
Implementations§
Source§impl Websocket
impl Websocket
Sourcepub async fn is_connected(&self) -> bool
pub async fn is_connected(&self) -> bool
Returns true
if the websocket is connected
Sourcepub async fn connect(&mut self) -> Result<()>
pub async fn connect(&mut self) -> Result<()>
Connect to the websocket
Examples found in repository?
examples/ws_all_mids.rs (line 16)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let subscription = Channel {
19 id: 1,
20 sub: Subscription::AllMids,
21 };
22
23 ws.subscribe(&[subscription]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received All Mids: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
More examples
examples/ws_l2_book.rs (line 16)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let books = Channel {
19 id: 3,
20 sub: Subscription::L2Book { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[books]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received L2 Books: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_trades.rs (line 16)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let trades = Channel {
19 id: 2,
20 sub: Subscription::Trades { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[trades]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received Trades: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_candle.rs (line 16)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let candle = Channel {
19 id: 2,
20 sub: Subscription::Candle {
21 coin: "BTC".into(),
22 interval: "5m".into(),
23 },
24 };
25
26 ws.subscribe(&[candle]).await?;
27
28 let handler = |event: Response| async move {
29 println!("Received Candle: \n--\n{:?}", event);
30
31 Ok(())
32 };
33
34 ws.next(handler).await?;
35
36 ws.disconnect().await?;
37
38 Ok(())
39}
examples/ws_web_data.rs (line 26)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let web_data = Channel {
29 id: 2,
30 sub: Subscription::WebData {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[web_data]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received Web Data: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
examples/ws_user_event.rs (line 26)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let user_event = Channel {
29 id: 2,
30 sub: Subscription::User {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[user_event]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received User Events: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
Additional examples can be found in:
Sourcepub async fn disconnect(&mut self) -> Result<()>
pub async fn disconnect(&mut self) -> Result<()>
Disconnect from the websocket
Examples found in repository?
examples/ws_all_mids.rs (line 33)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let subscription = Channel {
19 id: 1,
20 sub: Subscription::AllMids,
21 };
22
23 ws.subscribe(&[subscription]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received All Mids: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
More examples
examples/ws_l2_book.rs (line 33)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let books = Channel {
19 id: 3,
20 sub: Subscription::L2Book { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[books]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received L2 Books: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_trades.rs (line 33)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let trades = Channel {
19 id: 2,
20 sub: Subscription::Trades { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[trades]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received Trades: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_candle.rs (line 36)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let candle = Channel {
19 id: 2,
20 sub: Subscription::Candle {
21 coin: "BTC".into(),
22 interval: "5m".into(),
23 },
24 };
25
26 ws.subscribe(&[candle]).await?;
27
28 let handler = |event: Response| async move {
29 println!("Received Candle: \n--\n{:?}", event);
30
31 Ok(())
32 };
33
34 ws.next(handler).await?;
35
36 ws.disconnect().await?;
37
38 Ok(())
39}
examples/ws_web_data.rs (line 45)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let web_data = Channel {
29 id: 2,
30 sub: Subscription::WebData {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[web_data]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received Web Data: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
examples/ws_user_event.rs (line 45)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let user_event = Channel {
29 id: 2,
30 sub: Subscription::User {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[user_event]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received User Events: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
Additional examples can be found in:
Sourcepub async fn subscribe(&mut self, channels: &[Channel]) -> Result<()>
pub async fn subscribe(&mut self, channels: &[Channel]) -> Result<()>
Subscribe to the given channels
channels
- The channels to subscribe to
Examples found in repository?
examples/ws_all_mids.rs (line 23)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let subscription = Channel {
19 id: 1,
20 sub: Subscription::AllMids,
21 };
22
23 ws.subscribe(&[subscription]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received All Mids: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
More examples
examples/ws_l2_book.rs (line 23)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let books = Channel {
19 id: 3,
20 sub: Subscription::L2Book { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[books]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received L2 Books: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_trades.rs (line 23)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let trades = Channel {
19 id: 2,
20 sub: Subscription::Trades { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[trades]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received Trades: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_candle.rs (line 26)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let candle = Channel {
19 id: 2,
20 sub: Subscription::Candle {
21 coin: "BTC".into(),
22 interval: "5m".into(),
23 },
24 };
25
26 ws.subscribe(&[candle]).await?;
27
28 let handler = |event: Response| async move {
29 println!("Received Candle: \n--\n{:?}", event);
30
31 Ok(())
32 };
33
34 ws.next(handler).await?;
35
36 ws.disconnect().await?;
37
38 Ok(())
39}
examples/ws_web_data.rs (line 35)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let web_data = Channel {
29 id: 2,
30 sub: Subscription::WebData {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[web_data]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received Web Data: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
examples/ws_user_event.rs (line 35)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let user_event = Channel {
29 id: 2,
30 sub: Subscription::User {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[user_event]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received User Events: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
Additional examples can be found in:
Sourcepub async fn unsubscribe(&mut self, ids: &[u64]) -> Result<()>
pub async fn unsubscribe(&mut self, ids: &[u64]) -> Result<()>
Unsubscribe from the given channels
channels
- The channels to unsubscribe from
Sourcepub async fn unsubscribe_all(&mut self) -> Result<()>
pub async fn unsubscribe_all(&mut self) -> Result<()>
Unsubscribe from all channels
Sourcepub async fn next<F, Fut>(&mut self, handler: F) -> Result<Option<bool>>
pub async fn next<F, Fut>(&mut self, handler: F) -> Result<Option<bool>>
Examples found in repository?
examples/ws_all_mids.rs (line 31)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let subscription = Channel {
19 id: 1,
20 sub: Subscription::AllMids,
21 };
22
23 ws.subscribe(&[subscription]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received All Mids: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
More examples
examples/ws_l2_book.rs (line 31)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let books = Channel {
19 id: 3,
20 sub: Subscription::L2Book { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[books]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received L2 Books: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_trades.rs (line 31)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let trades = Channel {
19 id: 2,
20 sub: Subscription::Trades { coin: "BTC".into() },
21 };
22
23 ws.subscribe(&[trades]).await?;
24
25 let handler = |event: Response| async move {
26 println!("Received Trades: \n--\n{:?}", event);
27
28 Ok(())
29 };
30
31 ws.next(handler).await?;
32
33 ws.disconnect().await?;
34
35 Ok(())
36}
examples/ws_candle.rs (line 34)
13async fn main() -> Result<()> {
14 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
15
16 ws.connect().await?;
17
18 let candle = Channel {
19 id: 2,
20 sub: Subscription::Candle {
21 coin: "BTC".into(),
22 interval: "5m".into(),
23 },
24 };
25
26 ws.subscribe(&[candle]).await?;
27
28 let handler = |event: Response| async move {
29 println!("Received Candle: \n--\n{:?}", event);
30
31 Ok(())
32 };
33
34 ws.next(handler).await?;
35
36 ws.disconnect().await?;
37
38 Ok(())
39}
examples/ws_web_data.rs (line 43)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let web_data = Channel {
29 id: 2,
30 sub: Subscription::WebData {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[web_data]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received Web Data: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
examples/ws_user_event.rs (line 43)
16async fn main() -> Result<()> {
17 // Key was randomly generated for testing and shouldn't be used with any real funds
18 let wallet: Arc<LocalWallet> = Arc::new(
19 "e908f86dbb4d55ac876378565aafeabc187f6690f046459397b17d9b9a19688e"
20 .parse()
21 .unwrap(),
22 );
23
24 let mut ws: Websocket = Hyperliquid::new(Chain::Dev);
25
26 ws.connect().await?;
27
28 let user_event = Channel {
29 id: 2,
30 sub: Subscription::User {
31 user: wallet.address(),
32 },
33 };
34
35 ws.subscribe(&[user_event]).await?;
36
37 let handler = |event: Response| async move {
38 println!("Received User Events: \n--\n{:?}", event);
39
40 Ok(())
41 };
42
43 ws.next(handler).await?;
44
45 ws.disconnect().await?;
46
47 Ok(())
48}
Additional examples can be found in:
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for Websocket
impl !RefUnwindSafe for Websocket
impl Send for Websocket
impl Sync for Websocket
impl Unpin for Websocket
impl !UnwindSafe for Websocket
Blanket Implementations§
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> 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> 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> 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.