std/web/https

Library guide · API index and notation

This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.

import "std/web/https"

Names used in signatures

Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.

PEM_BYTES

Constant · Source

Explicit OpenSSL selection. Files are read once per serving call into fixed storage and remain alive until all accepted TLS connections have closed.

pub const PEM_BYTES: usize = 8192

STAGING_BYTES

Constant · Source

pub const STAGING_BYTES: usize = 8192

WORKSPACE_BYTES

Constant · Source

pub const WORKSPACE_BYTES: usize = reactor.WORKSPACE_BYTES + STAGING_BYTES

ErrorKind

Enum · Source

pub enum ErrorKind {
    File, CredentialLimit, Serving
}

Error

Struct · Source

pub struct Error {
    pub kind: ErrorKind
    pub path: &str
    pub file: Option<fs.FileError>
    pub serving: Option<hosting.Error>
}

Error.format

Function · Source

pub fn format<F>(&self, output: &mut F) -> void!io.Error

Files

Struct · Source

pub struct Files {
    // Private implementation fields omitted.
}

Files.serve

Function · Source

pub fn serve<H>(&self, server: app.Server<H>, address: &[u8]) -> hosted.Report!Error from(self)

Files.serve_until

Function · Source

pub fn serve_until<H, X>(&self, server: app.Server<H>, address: &[u8], cancel: &X) -> hosted.Report!Error from(self)

Files.serve_with

Function · Source

pub fn serve_with<H, C, X>(&self, server: app.Server<H>, address: &[u8], storage: &mut app.Storage,
    clock: &mut C, cancel: &X) -> hosted.Report!Error from(self)

files

Function · Source

pub fn files(certificate: &str, key: &str) -> Files from(certificate, key)

SessionState

Struct · Source

TLS engines own their backend allocations. Only movable bookkeeping is retained here; each slot’s ciphertext lives in caller-provided workspace.

pub struct SessionState {
    // Private implementation fields omitted.
}

Provider

Struct · Source

pub struct Provider {
    // Private implementation fields omitted.
}

Provider.new

Function · Source

pub fn new(identity: openssl.Config) -> Provider from(identity)

Provider.handshake_required

Function · Source

pub fn handshake_required(&self) -> bool

Provider.staging_bytes

Function · Source

pub fn staging_bytes(&self) -> usize

Provider.open

Function · Source

pub fn open(&mut self, index: usize, socket: &mut native.TcpConnection, staging: &mut[u8]) -> Session!hosting.Error from(socket, staging)

Provider.save

Function · Source

pub fn save(&mut self, index: usize, state: SessionState)

Provider.close

Function · Source

pub fn close(&mut self, index: usize)

Session

Struct · Source

pub struct Session {
    // Private implementation fields omitted.
}

Session.poll_read

Function · Source

pub fn poll_read(&mut self, data: &mut[u8]) -> io.Poll!io.Error

Session.poll_write

Function · Source

pub fn poll_write(&mut self, data: &[u8]) -> io.Poll!io.Error

Session.handshake

Function · Source

pub fn handshake(&mut self) -> bool!hosting.Error

Session.flush

Function · Source

pub fn flush(&mut self) -> bool!hosting.Error

Session.finish

Function · Source

pub fn finish(&mut self) -> bool!hosting.Error

Session.prepare

Function · Source

pub fn prepare(&mut self) -> bool!hosting.Error

Session.writing

Function · Source

pub fn writing(&self, http_writing: bool) -> bool

Session.take_error

Function · Source

pub fn take_error(&mut self) -> Option<hosting.Error>

Session.suspend

Function · Source

pub fn suspend(self) -> SessionState