W3cubDocs

/Rust

Struct std::os::unix::net::UnixStream

pub struct UnixStream(_);
This is supported on Unix only.

A Unix stream socket.

Examples

use std::os::unix::net::UnixStream;
use std::io::prelude::*;

let mut stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.write_all(b"hello world").unwrap();
let mut response = String::new();
stream.read_to_string(&mut response).unwrap();
println!("{}", response);

Methods

impl UnixStream[src]

pub fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>[src]

This is supported on Unix only.

Connects to the socket named by path.

Examples

use std::os::unix::net::UnixStream;

let socket = match UnixStream::connect("/tmp/sock") {
    Ok(sock) => sock,
    Err(e) => {
        println!("Couldn't connect: {:?}", e);
        return
    }
};

pub fn pair() -> Result<(UnixStream, UnixStream)>[src]

This is supported on Unix only.

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

Examples

use std::os::unix::net::UnixStream;

let (sock1, sock2) = match UnixStream::pair() {
    Ok((sock1, sock2)) => (sock1, sock2),
    Err(e) => {
        println!("Couldn't create a pair of sockets: {:?}", e);
        return
    }
};

pub fn try_clone(&self) -> Result<UnixStream>[src]

This is supported on Unix only.

Creates a new independently owned handle to the underlying socket.

The returned UnixStream is a reference to the same stream that this object references. Both handles will read and write the same stream of data, and options set on one stream will be propagated to the other stream.

Examples

use std::os::unix::net::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let sock_copy = socket.try_clone().expect("Couldn't clone socket");

pub fn local_addr(&self) -> Result<SocketAddr>[src]

This is supported on Unix only.

Returns the socket address of the local half of this connection.

Examples

use std::os::unix::net::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let addr = socket.local_addr().expect("Couldn't get local address");

pub fn peer_addr(&self) -> Result<SocketAddr>[src]

This is supported on Unix only.

Returns the socket address of the remote half of this connection.

Examples

use std::os::unix::net::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let addr = socket.peer_addr().expect("Couldn't get peer address");

pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>[src]

This is supported on Unix only.

Sets the read timeout for the socket.

If the provided value is None, then read calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

Examples

use std::os::unix::net::UnixStream;
use std::time::Duration;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout");

An Err is returned if the zero Duration is passed to this method:

use std::io;
use std::os::unix::net::UnixStream;
use std::time::Duration;

let socket = UnixStream::connect("/tmp/sock").unwrap();
let result = socket.set_read_timeout(Some(Duration::new(0, 0)));
let err = result.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput)

pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>[src]

This is supported on Unix only.

Sets the write timeout for the socket.

If the provided value is None, then write calls will block indefinitely. An Err is returned if the zero Duration is passed to this method.

Examples

use std::os::unix::net::UnixStream;
use std::time::Duration;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_write_timeout(Some(Duration::new(1, 0))).expect("Couldn't set write timeout");

An Err is returned if the zero Duration is passed to this method:

use std::io;
use std::net::UdpSocket;
use std::time::Duration;

let socket = UdpSocket::bind("127.0.0.1:34254").unwrap();
let result = socket.set_write_timeout(Some(Duration::new(0, 0)));
let err = result.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput)

pub fn read_timeout(&self) -> Result<Option<Duration>>[src]

This is supported on Unix only.

Returns the read timeout of this socket.

Examples

use std::os::unix::net::UnixStream;
use std::time::Duration;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout");
assert_eq!(socket.read_timeout().unwrap(), Some(Duration::new(1, 0)));

pub fn write_timeout(&self) -> Result<Option<Duration>>[src]

This is supported on Unix only.

Returns the write timeout of this socket.

Examples

use std::os::unix::net::UnixStream;
use std::time::Duration;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_write_timeout(Some(Duration::new(1, 0))).expect("Couldn't set write timeout");
assert_eq!(socket.write_timeout().unwrap(), Some(Duration::new(1, 0)));

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>[src]

This is supported on Unix only.

Moves the socket into or out of nonblocking mode.

Examples

use std::os::unix::net::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.set_nonblocking(true).expect("Couldn't set nonblocking");

pub fn take_error(&self) -> Result<Option<Error>>[src]

This is supported on Unix only.

Returns the value of the SO_ERROR option.

Examples

use std::os::unix::net::UnixStream;

let socket = UnixStream::connect("/tmp/sock").unwrap();
if let Ok(Some(err)) = socket.take_error() {
    println!("Got error: {:?}", err);
}

Platform specific

On Redox this always returns None.

pub fn shutdown(&self, how: Shutdown) -> Result<()>[src]

This is supported on Unix only.

Shuts down the read, write, or both halves of this connection.

This function will cause all pending and future I/O calls on the specified portions to immediately return with an appropriate value (see the documentation of Shutdown).

Examples

use std::os::unix::net::UnixStream;
use std::net::Shutdown;

let socket = UnixStream::connect("/tmp/sock").unwrap();
socket.shutdown(Shutdown::Both).expect("shutdown function failed");

Trait Implementations

impl Read for UnixStream[src]

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>[src]1.0.0

Read all bytes until EOF in this source, placing them into buf. Read more

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>[src]1.0.0

Read all bytes until EOF in this source, appending them to buf. Read more

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>[src]1.6.0

Read the exact number of bytes required to fill buf. Read more

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, [src]1.0.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Creates a "by reference" adaptor for this instance of Read. Read more

fn bytes(self) -> Bytes<Self> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Bytes<R>
impl<R: Read> Iterator for Bytes<R>
    type Item = Result<u8>;

Transforms this Read instance to an [Iterator] over its bytes. Read more

fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Chain<T, U>
impl<T: Read, U: Read> Read for Chain<T, U>

Creates an adaptor which will chain this stream with another. Read more

fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Take<T>
impl<T: Read> Read for Take<T>

Creates an adaptor which will read at most limit bytes from it. Read more

impl<'a> Read for &'a UnixStream[src]

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>[src]1.0.0

Read all bytes until EOF in this source, placing them into buf. Read more

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>[src]1.0.0

Read all bytes until EOF in this source, appending them to buf. Read more

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>[src]1.6.0

Read the exact number of bytes required to fill buf. Read more

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, [src]1.0.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Creates a "by reference" adaptor for this instance of Read. Read more

fn bytes(self) -> Bytes<Self> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Bytes<R>
impl<R: Read> Iterator for Bytes<R>
    type Item = Result<u8>;

Transforms this Read instance to an [Iterator] over its bytes. Read more

fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Chain<T, U>
impl<T: Read, U: Read> Read for Chain<T, U>

Creates an adaptor which will chain this stream with another. Read more

fn take(self, limit: u64) -> Take<Self> where
    Self: Sized, [src]1.0.0

ⓘImportant traits for Take<T>
impl<T: Read> Read for Take<T>

Creates an adaptor which will read at most limit bytes from it. Read more

impl Write for UnixStream[src]

fn write_all(&mut self, buf: &[u8]) -> Result<()>[src]1.0.0

Attempts to write an entire buffer into this writer. Read more

fn write_fmt(&mut self, fmt: Arguments) -> Result<()>[src]1.0.0

Writes a formatted string into this writer, returning any error encountered. Read more

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, [src]1.0.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Creates a "by reference" adaptor for this instance of Write. Read more

impl<'a> Write for &'a UnixStream[src]

fn write_all(&mut self, buf: &[u8]) -> Result<()>[src]1.0.0

Attempts to write an entire buffer into this writer. Read more

fn write_fmt(&mut self, fmt: Arguments) -> Result<()>[src]1.0.0

Writes a formatted string into this writer, returning any error encountered. Read more

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, [src]1.0.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Creates a "by reference" adaptor for this instance of Write. Read more

impl AsRawFd for UnixStream[src]

impl FromRawFd for UnixStream[src]

ⓘImportant traits for UnixStream
impl Read for UnixStream
impl<'a> Read for &'a UnixStream
impl Write for UnixStream
impl<'a> Write for &'a UnixStream

impl IntoRawFd for UnixStream[src]

impl Debug for UnixStream[src]

Auto Trait Implementations

Blanket Implementations

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/os/unix/net/struct.UnixStream.html