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]

[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
    }
};

[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
    }
};

[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");

[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");

[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");

[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. It is an error to pass the zero Duration 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");

[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. It is an error to pass the zero Duration 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");

[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)));

[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)));

[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");

[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);
}

[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 Debug for UnixStream [src]

[src]

Formats the value using the given formatter. Read more

impl Read for UnixStream [src]

[src]

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

[src]

🔬 This is a nightly-only experimental API. (read_initializer #42788)

Determines if this Reader can work with buffers of uninitialized memory. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.6.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

[src]

🔬 This is a nightly-only experimental API. (io #27802)the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s. Read more

1.0.0
[src]

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

1.0.0
[src]

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

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

[src]

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

[src]

🔬 This is a nightly-only experimental API. (read_initializer #42788)

Determines if this Reader can work with buffers of uninitialized memory. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.6.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

[src]

🔬 This is a nightly-only experimental API. (io #27802)the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s. Read more

1.0.0
[src]

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

1.0.0
[src]

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

impl Write for UnixStream [src]

[src]

Write a buffer into this object, returning how many bytes were written. Read more

[src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

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

[src]

Write a buffer into this object, returning how many bytes were written. Read more

[src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.0.0
[src]

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

impl AsRawFd for UnixStream [src]

[src]

This is supported on Unix only.

Extracts the raw file descriptor. Read more

impl FromRawFd for UnixStream [src]

[src]

This is supported on Unix only.

Constructs a new instance of Self from the given raw file descriptor. Read more

impl IntoRawFd for UnixStream [src]

[src]

This is supported on Unix only.

Consumes this object, returning the raw underlying file descriptor. Read more

© 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