Skip to main content

TcpStream

Struct TcpStream 

Source
pub struct TcpStream { /* private fields */ }
Expand description

A goroutine-aware TCP stream socket.

read and write park the goroutine when the operation would block and resume it when data is available or the send buffer has space.

Implementations§

Source§

impl TcpStream

Source

pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<Self>

Connect to addr.

Parks the goroutine until the connection completes if it does not complete immediately (which is typical for non-blocking connect).

Equivalent to net.Dial("tcp", addr) in Go.

Source

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Read bytes from the stream into buf.

Parks the goroutine if no data is immediately available.

Source

pub fn write(&mut self, buf: &[u8]) -> Result<usize>

Write buf to the stream.

Parks the goroutine if the send buffer is full. Returns the number of bytes written (may be less than buf.len()).

Source

pub fn as_raw_fd(&self) -> RawFd

Return the underlying raw file descriptor.

Trait Implementations§

Source§

impl Drop for TcpStream

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.