Struct rustls::ClientSession [−][src]
pub struct ClientSession { /* fields omitted */ }
This represents a single TLS client session.
Methods
impl ClientSession
[src]
impl ClientSession
ⓘImportant traits for ClientSessionpub fn new(config: &Arc<ClientConfig>, hostname: DNSNameRef) -> ClientSession
[src]
pub fn new(config: &Arc<ClientConfig>, hostname: DNSNameRef) -> ClientSession
Make a new ClientSession. config
controls how
we behave in the TLS protocol, hostname
is the
hostname of who we want to talk to.
Trait Implementations
impl Debug for ClientSession
[src]
impl Debug for ClientSession
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Session for ClientSession
[src]
impl Session for ClientSession
fn read_tls(&mut self, rd: &mut Read) -> Result<usize>
[src]
fn read_tls(&mut self, rd: &mut Read) -> Result<usize>
Read TLS content from rd
. This method does internal buffering, so rd
can supply TLS messages in arbitrary- sized chunks (like a socket or pipe might). Read more
fn write_tls(&mut self, wr: &mut Write) -> Result<usize>
[src]
fn write_tls(&mut self, wr: &mut Write) -> Result<usize>
Writes TLS messages to wr
.
fn writev_tls(&mut self, wr: &mut WriteV) -> Result<usize>
[src]
fn writev_tls(&mut self, wr: &mut WriteV) -> Result<usize>
Like write_tls
, but writes potentially many records in one go via wr
; a rustls::WriteV
. This function has the same semantics as write_tls
otherwise. Read more
fn process_new_packets(&mut self) -> Result<(), TLSError>
[src]
fn process_new_packets(&mut self) -> Result<(), TLSError>
Processes any new packets read by a previous call to read_tls
. Errors from this function relate to TLS protocol errors, and are fatal to the session. Future calls after an error will do no new work and will return the same error. Read more
fn wants_read(&self) -> bool
[src]
fn wants_read(&self) -> bool
Returns true if the caller should call read_tls
as soon as possible. Read more
fn wants_write(&self) -> bool
[src]
fn wants_write(&self) -> bool
Returns true if the caller should call write_tls
as soon as possible. Read more
fn is_handshaking(&self) -> bool
[src]
fn is_handshaking(&self) -> bool
Returns true if the session is currently perform the TLS handshake. During this time plaintext written to the session is buffered in memory. Read more
fn set_buffer_limit(&mut self, len: usize)
[src]
fn set_buffer_limit(&mut self, len: usize)
Sets a limit on the internal buffers used to buffer unsent plaintext (prior to completing the TLS handshake) and unsent TLS records. Read more
fn send_close_notify(&mut self)
[src]
fn send_close_notify(&mut self)
Queues a close_notify fatal alert to be sent in the next write_tls
call. This informs the peer that the connection is being closed. Read more
fn get_peer_certificates(&self) -> Option<Vec<Certificate>>
[src]
fn get_peer_certificates(&self) -> Option<Vec<Certificate>>
Retrieves the certificate chain used by the peer to authenticate. Read more
fn get_alpn_protocol(&self) -> Option<&str>
[src]
fn get_alpn_protocol(&self) -> Option<&str>
Retrieves the protocol agreed with the peer via ALPN. Read more
fn get_protocol_version(&self) -> Option<ProtocolVersion>
[src]
fn get_protocol_version(&self) -> Option<ProtocolVersion>
Retrieves the protocol version agreed with the peer. Read more
fn export_keying_material(
&self,
output: &mut [u8],
label: &[u8],
context: Option<&[u8]>
) -> Result<(), TLSError>
[src]
fn export_keying_material(
&self,
output: &mut [u8],
label: &[u8],
context: Option<&[u8]>
) -> Result<(), TLSError>
Derives key material from the agreed session secrets. Read more
fn get_negotiated_ciphersuite(&self) -> Option<&'static SupportedCipherSuite>
[src]
fn get_negotiated_ciphersuite(&self) -> Option<&'static SupportedCipherSuite>
Retrieves the ciphersuite agreed with the peer. Read more
fn complete_io<T>(&mut self, io: &mut T) -> Result<(usize, usize), Error> where
Self: Sized,
T: Read + Write,
[src]
fn complete_io<T>(&mut self, io: &mut T) -> Result<(usize, usize), Error> where
Self: Sized,
T: Read + Write,
This function uses io
to complete any outstanding IO for this session. Read more
impl Read for ClientSession
[src]
impl Read for ClientSession
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Obtain plaintext data received from the peer over this TLS connection.
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
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, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn bytes(self) -> Bytes<Self>
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self>
[src]
fn chars(self) -> Chars<Self>
: Use str::from_utf8 instead: https://doc.rust-lang.org/nightly/std/str/struct.Utf8Error.html#examples
🔬 This is a nightly-only experimental API. (io
)
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
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
fn take(self, limit: u64) -> Take<Self>
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for ClientSession
[src]
impl Write for ClientSession
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Send the plaintext buf
to the peer, encrypting
and authenticating it. Once this function succeeds
you should call write_tls
which will output the
corresponding TLS records.
This function buffers plaintext sent before the TLS handshake completes, and sends it as soon as it can. This buffer is of unlimited size so writing much data before it can be sent will cause excess memory usage.
fn flush(&mut self) -> Result<()>
[src]
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
Creates a "by reference" adaptor for this instance of Write
. Read more
Auto Trait Implementations
impl Send for ClientSession
impl Send for ClientSession
impl Sync for ClientSession
impl Sync for ClientSession