socks2 0.4.0

SOCKS proxy clients
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# socks2

[![Crates.io Version](https://img.shields.io/crates/v/socks2?style=flat-square&color=blue)](https://crates.io/crates/socks2)
[![docs.rs](https://img.shields.io/docsrs/socks2?style=flat-square)](https://docs.rs/socks2)
[![Crates.io MSRV](https://img.shields.io/crates/msrv/socks2?style=flat-square)](https://www.rust-lang.org/tools/install)

SOCKS proxy support for Rust.

A fork of [sfackler/rust-socks](https://github.com/sfackler/rust-socks).

See [changes](CHANGELOG.md).

## Using

```cargo add socks2```

```toml
[dependencies]
socks2 = "0.4"
```

### Features

#### client

```toml
[dependencies]
socks2 = { version = "0.4", default-features = false, features = ["client"] }
```

```rust
use socks2::Socks4Stream;
use socks2::Socks5Stream;
use std::io::Write;

let mut connection = Socks4Stream::connect(PROXY, &TARGET, "userid", None).unwrap();
let buf = [126_u8; 50]
connection.write(&buf);

let mut connection = Socks5Stream::connect(PROXY, &TARGET, None).unwrap();
let buf = [126_u8; 50]
connection.write(&buf);
```

#### bind

```toml
[dependencies]
socks2 = { version = "0.4", default-features = false, features = ["bind"] }
```

```rust
use socks2::Socks4Listener;
use socks2::Socks5Listener;

let mut connection = Socks4Listener::bind(PROXY, &TARGET, "userid", None)
    .unwrap()
    .accept();

let mut connection = Socks5Listener::bind(PROXY, &TARGET, None)
    .unwrap()
    .accept();
```

#### udp

```toml
[dependencies]
socks2 = { version = "0.4", default-features = false, features = ["udp"] }
```

```rust
use socks2::Socks5Datagram;
use std::io::Write;

let mut connection = Socks5Datagram::bind(PROXY, &TARGET, None).unwrap();
let buf = [126_u8; 50]
connection.send_to(&buf, &OTHER_ADDR);
```
## Versioning

socks2 follows Major Zero Semver.
The major version is always zero.
Every minor version contains breaking changes.
Every patch version will be backwards compatible.

Alpha, Betas, and Release Candidates may contain breaking changes
between any version.