From 64106c4d3d4ddba8c7bc2af75376e6d3d3d75601 Mon Sep 17 00:00:00 2001 From: Date: Mon, 29 Jun 2015 20:16:15 +0000 Subject: Update documentation --- openssl/ssl/struct.SslStream.html | 148 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 openssl/ssl/struct.SslStream.html (limited to 'openssl/ssl/struct.SslStream.html') diff --git a/openssl/ssl/struct.SslStream.html b/openssl/ssl/struct.SslStream.html new file mode 100644 index 0000000..6e31889 --- /dev/null +++ b/openssl/ssl/struct.SslStream.html @@ -0,0 +1,148 @@ + + + + + + + + + + openssl::ssl::SslStream - Rust + + + + + + + + + + + + + + + +
+

Struct openssl::ssl::SslStream + + [] + + [src]

+
pub struct SslStream<S> {
+    // some fields omitted
+}

A stream wrapper which handles SSL encryption for an underlying stream.

+

Methods

impl SslStream<TcpStream>

fn try_clone(&self) -> Result<SslStream<TcpStream>>

+

Create a new independently owned handle to the underlying socket.

+

impl<S: Read + Write> SslStream<S>

fn new_server_from(ssl: Ssl, stream: S) -> Result<SslStream<S>, SslError>

+

fn new_from(ssl: Ssl, stream: S) -> Result<SslStream<S>, SslError>

+

Attempts to create a new SSL stream from a given Ssl instance.

+

fn new(ctx: &SslContext, stream: S) -> Result<SslStream<S>, SslError>

+

Creates a new SSL stream

+

fn new_server(ctx: &SslContext, stream: S) -> Result<SslStream<S>, SslError>

+

Creates a new SSL server stream

+

fn get_ref(&self) -> &S

+

Returns a reference to the underlying stream.

+

fn get_peer_certificate(&self) -> Option<X509>

+

Return the certificate of the peer

+

fn get_mut(&mut self) -> &mut S

+

Returns a mutable reference to the underlying stream.

+ +

Warning

+

It is inadvisable to read from or write to the underlying stream as it +will most likely desynchronize the SSL session.

+

fn get_compression(&self) -> Option<String>

+

Get the compression currently in use. The result will be +either None, indicating no compression is in use, or a string +with the compression name.

+

fn pending(&self) -> usize

+

pending() takes into account only bytes from the TLS/SSL record that is currently being processed (if any).

+

Trait Implementations

impl<S> Debug for SslStream<S> where S: Debug

fn fmt(&self, fmt: &mut Formatter) -> Result

+

impl<S: Read + Write> Read for SslStream<S>

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

+

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

+

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

+

fn by_ref(&mut self) -> &mut Self

+

fn bytes(self) -> Bytes<Self>

+

fn chars(self) -> Chars<Self>

+

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read

+

fn take(self, limit: u64) -> Take<Self>

+

fn tee<W>(self, out: W) -> Tee<Self, W> where W: Write

+

impl<S: Read + Write> Write for SslStream<S>

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

+

fn flush(&mut self) -> Result<()>

+

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

+

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

+

fn by_ref(&mut self) -> &mut Self

+

fn broadcast<W>(self, other: W) -> Broadcast<Self, W> where W: Write

+

Derived Implementations

impl<S: Clone> Clone for SslStream<S> where S: Clone

fn clone(&self) -> SslStream<S>

+

fn clone_from(&mut self, source: &Self)

+
+ + + + + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3