diff --git a/404.html b/404.html
new file mode 100755
index 00000000..4c370a36
--- /dev/null
+++ b/404.html
@@ -0,0 +1,1659 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Sandwich: Technical Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 404 - Not found
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Changelog
+v0.1.0 (Aug 8, 2023)
+Initial public release
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/`
+
diff --git a/assets/.doxy/cAPI/cAPI/dir_f6ef5a90171f1138cc160f006fc74f9c.md b/assets/.doxy/cAPI/cAPI/dir_f6ef5a90171f1138cc160f006fc74f9c.md
new file mode 100755
index 00000000..e4d64fd5
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/dir_f6ef5a90171f1138cc160f006fc74f9c.md
@@ -0,0 +1,95 @@
+
+
+# Dir docs/sandwich\_c
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md)
+
+
+
+
+
+
+
+
+
+
+
+
+## Files
+
+| Type | Name |
+| ---: | :--- |
+| file | [**error.h**](error_8h.md)
_Error handling for the Sandwich library._ |
+| file | [**error\_codes.h**](error__codes_8h.md)
_Sandwich errors specification._ |
+| file | [**export.h**](export_8h.md)
|
+| file | [**io.h**](io_8h.md)
_I/O abstraction for Sandwich._ |
+| file | [**ioerrors.h**](ioerrors_8h.md)
_Sandwich I/O errors specification._ |
+| file | [**lib.h**](lib_8h.md)
_Top-level context for the Sandwich library._ |
+| file | [**listener.h**](listener_8h.md)
_Sandwich C library, on top of the Rust implementation._ |
+| file | [**sandwich.h**](sandwich_8h.md)
_Sandwich C library, on top of the Rust implementation._ |
+| file | [**tunnel.h**](tunnel_8h.md)
_Sandwich Tunnel API._ |
+| file | [**tunnel\_types.h**](tunnel__types_8h.md)
_Sandwich tunnel types and states specification._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/`
+
diff --git a/assets/.doxy/cAPI/cAPI/error_8h.md b/assets/.doxy/cAPI/cAPI/error_8h.md
new file mode 100755
index 00000000..5e8550d4
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/error_8h.md
@@ -0,0 +1,179 @@
+
+
+# File error.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**error.h**](error_8h.md)
+
+[Go to the source code of this file](error_8h_source.md)
+
+_Error handling for the Sandwich library._
+
+* `#include "sandwich_c/error_codes.h"`
+* `#include "sandwich_c/export.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| struct | [**SandwichError**](structSandwichError.md)
_An error code._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_error\_free**](#function-sandwich_error_free) (struct [**SandwichError**](structSandwichError.md) \* chain)
_Free an error chain._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_error\_stack\_str\_free**](#function-sandwich_error_stack_str_free) (const char \* err\_str)
_Free a an error string (generated from sandwich\_error\_stack\_str\_new)_ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) char \* | [**sandwich\_error\_stack\_str\_new**](#function-sandwich_error_stack_str_new) (const struct [**SandwichError**](structSandwichError.md) \* chain)
_Create an error stack string from a_ [_**SandwichError**_](structSandwichError.md) _chain._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions Documentation
+
+
+
+
+### function sandwich\_error\_free
+
+_Free an error chain._
+```C++
+SANDWICH_API void sandwich_error_free (
+ struct SandwichError * chain
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `chain` Error chain.
+
+
+
+
+
+
+
+
+### function sandwich\_error\_stack\_str\_free
+
+_Free a an error string (generated from sandwich\_error\_stack\_str\_new)_
+```C++
+SANDWICH_API void sandwich_error_stack_str_free (
+ const char * err_str
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `err_str` Pointer to error string to free.
+
+NULL for err\_str is allowed.
+
+
+
+
+
+
+### function sandwich\_error\_stack\_str\_new
+
+_Create an error stack string from a_ [_**SandwichError**_](structSandwichError.md) _chain._
+```C++
+SANDWICH_API char * sandwich_error_stack_str_new (
+ const struct SandwichError * chain
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `chain` Error chain.
+
+
+
+**Returns:**
+
+A NUL terminated string describing the [**SandwichError**](structSandwichError.md) chain
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/error.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/error_8h_source.md b/assets/.doxy/cAPI/cAPI/error_8h_source.md
new file mode 100755
index 00000000..6bb118c6
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/error_8h_source.md
@@ -0,0 +1,46 @@
+
+
+# File error.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**error.h**](error_8h.md)
+
+[Go to the documentation of this file](error_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+
+#pragma once
+
+#include "sandwich_c/error_codes.h"
+#include "sandwich_c/export.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct SandwichError {
+ struct SandwichError *details;
+
+ const char *msg;
+
+ SandwichErrorKind kind;
+
+ int code;
+};
+
+SANDWICH_API void sandwich_error_free(struct SandwichError *chain);
+
+SANDWICH_API char *
+sandwich_error_stack_str_new(const struct SandwichError *chain);
+
+SANDWICH_API void sandwich_error_stack_str_free(const char *err_str);
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/error__codes_8h.md b/assets/.doxy/cAPI/cAPI/error__codes_8h.md
new file mode 100755
index 00000000..c815e100
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/error__codes_8h.md
@@ -0,0 +1,542 @@
+
+
+# File error\_codes.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**error\_codes.h**](error__codes_8h.md)
+
+[Go to the source code of this file](error__codes_8h_source.md)
+
+_Sandwich errors specification._
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types
+
+| Type | Name |
+| ---: | :--- |
+| enum | [**SandwichALPNError**](#enum-sandwichalpnerror)
_Enum ALPNError._ |
+| typedef enum [**SandwichALPNError**](error__codes_8h.md#enum-sandwichalpnerror) | [**SandwichALPNError**](#typedef-sandwichalpnerror)
|
+| enum | [**SandwichAPIError**](#enum-sandwichapierror)
_Enum APIError._ |
+| typedef enum [**SandwichAPIError**](error__codes_8h.md#enum-sandwichapierror) | [**SandwichAPIError**](#typedef-sandwichapierror)
|
+| enum | [**SandwichASN1Error**](#enum-sandwichasn1error)
_Enum ASN1Error._ |
+| typedef enum [**SandwichASN1Error**](error__codes_8h.md#enum-sandwichasn1error) | [**SandwichASN1Error**](#typedef-sandwichasn1error)
|
+| enum | [**SandwichCertificateError**](#enum-sandwichcertificateerror)
_Enum CertificateError._ |
+| typedef enum [**SandwichCertificateError**](error__codes_8h.md#enum-sandwichcertificateerror) | [**SandwichCertificateError**](#typedef-sandwichcertificateerror)
|
+| enum | [**SandwichConfigurationError**](#enum-sandwichconfigurationerror)
_Enum ConfigurationError._ |
+| typedef enum [**SandwichConfigurationError**](error__codes_8h.md#enum-sandwichconfigurationerror) | [**SandwichConfigurationError**](#typedef-sandwichconfigurationerror)
|
+| enum | [**SandwichDataSourceError**](#enum-sandwichdatasourceerror)
_Enum DataSourceError._ |
+| typedef enum [**SandwichDataSourceError**](error__codes_8h.md#enum-sandwichdatasourceerror) | [**SandwichDataSourceError**](#typedef-sandwichdatasourceerror)
|
+| enum | [**SandwichErrorKind**](#enum-sandwicherrorkind)
_Enum ErrorKind._ |
+| typedef enum [**SandwichErrorKind**](error__codes_8h.md#enum-sandwicherrorkind) | [**SandwichErrorKind**](#typedef-sandwicherrorkind)
|
+| enum | [**SandwichHandshakeError**](#enum-sandwichhandshakeerror)
_Enum HandshakeError._ |
+| typedef enum [**SandwichHandshakeError**](error__codes_8h.md#enum-sandwichhandshakeerror) | [**SandwichHandshakeError**](#typedef-sandwichhandshakeerror)
|
+| enum | [**SandwichKEMError**](#enum-sandwichkemerror)
_Enum KEMError._ |
+| typedef enum [**SandwichKEMError**](error__codes_8h.md#enum-sandwichkemerror) | [**SandwichKEMError**](#typedef-sandwichkemerror)
|
+| enum | [**SandwichPrivateKeyError**](#enum-sandwichprivatekeyerror)
_Enum PrivateKeyError._ |
+| typedef enum [**SandwichPrivateKeyError**](error__codes_8h.md#enum-sandwichprivatekeyerror) | [**SandwichPrivateKeyError**](#typedef-sandwichprivatekeyerror)
|
+| enum | [**SandwichProtobufError**](#enum-sandwichprotobuferror)
_Enum ProtobufError._ |
+| typedef enum [**SandwichProtobufError**](error__codes_8h.md#enum-sandwichprotobuferror) | [**SandwichProtobufError**](#typedef-sandwichprotobuferror)
|
+| enum | [**SandwichSocketError**](#enum-sandwichsocketerror)
_Enum SocketError._ |
+| typedef enum [**SandwichSocketError**](error__codes_8h.md#enum-sandwichsocketerror) | [**SandwichSocketError**](#typedef-sandwichsocketerror)
|
+| enum | [**SandwichSystemError**](#enum-sandwichsystemerror)
_Enum SystemError._ |
+| typedef enum [**SandwichSystemError**](error__codes_8h.md#enum-sandwichsystemerror) | [**SandwichSystemError**](#typedef-sandwichsystemerror)
|
+| enum | [**SandwichTLSConfigurationError**](#enum-sandwichtlsconfigurationerror)
_Enum TLSConfigurationError._ |
+| typedef enum [**SandwichTLSConfigurationError**](error__codes_8h.md#enum-sandwichtlsconfigurationerror) | [**SandwichTLSConfigurationError**](#typedef-sandwichtlsconfigurationerror)
|
+| enum | [**SandwichTunnelError**](#enum-sandwichtunnelerror)
_Enum TunnelError._ |
+| typedef enum [**SandwichTunnelError**](error__codes_8h.md#enum-sandwichtunnelerror) | [**SandwichTunnelError**](#typedef-sandwichtunnelerror)
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types Documentation
+
+
+
+
+### enum SandwichALPNError
+
+```C++
+enum SandwichALPNError {
+ SANDWICH_ALPNERROR_LENGTH_ERROR = 0,
+ SANDWICH_ALPNERROR_INVALID_STRING = 1
+};
+```
+
+
+
+
+
+
+### typedef SandwichALPNError
+
+```C++
+typedef enum SandwichALPNError SandwichALPNError;
+```
+
+
+
+
+
+
+### enum SandwichAPIError
+
+```C++
+enum SandwichAPIError {
+ SANDWICH_APIERROR_CONFIGURATION = 0,
+ SANDWICH_APIERROR_SOCKET = 1,
+ SANDWICH_APIERROR_TUNNEL = 2
+};
+```
+
+
+
+
+
+
+### typedef SandwichAPIError
+
+```C++
+typedef enum SandwichAPIError SandwichAPIError;
+```
+
+
+
+
+
+
+### enum SandwichASN1Error
+
+```C++
+enum SandwichASN1Error {
+ SANDWICH_ASN1ERROR_INVALID_FORMAT = 0,
+ SANDWICH_ASN1ERROR_MALFORMED = 1
+};
+```
+
+
+
+
+
+
+### typedef SandwichASN1Error
+
+```C++
+typedef enum SandwichASN1Error SandwichASN1Error;
+```
+
+
+
+
+
+
+### enum SandwichCertificateError
+
+```C++
+enum SandwichCertificateError {
+ SANDWICH_CERTIFICATEERROR_MALFORMED = 0,
+ SANDWICH_CERTIFICATEERROR_EXPIRED = 1,
+ SANDWICH_CERTIFICATEERROR_NOT_FOUND = 2,
+ SANDWICH_CERTIFICATEERROR_UNKNOWN = 3,
+ SANDWICH_CERTIFICATEERROR_UNSUPPORTED = 4
+};
+```
+
+
+
+
+
+
+### typedef SandwichCertificateError
+
+```C++
+typedef enum SandwichCertificateError SandwichCertificateError;
+```
+
+
+
+
+
+
+### enum SandwichConfigurationError
+
+```C++
+enum SandwichConfigurationError {
+ SANDWICH_CONFIGURATIONERROR_INVALID_IMPLEMENTATION = 0,
+ SANDWICH_CONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION = 1,
+ SANDWICH_CONFIGURATIONERROR_INVALID = 2,
+ SANDWICH_CONFIGURATIONERROR_INVALID_LISTENER = 3
+};
+```
+
+
+
+
+
+
+### typedef SandwichConfigurationError
+
+```C++
+typedef enum SandwichConfigurationError SandwichConfigurationError;
+```
+
+
+
+
+
+
+### enum SandwichDataSourceError
+
+```C++
+enum SandwichDataSourceError {
+ SANDWICH_DATASOURCEERROR_EMPTY = 0,
+ SANDWICH_DATASOURCEERROR_INVALID_CASE = 1,
+ SANDWICH_DATASOURCEERROR_NOT_FOUND = 2
+};
+```
+
+
+
+
+
+
+### typedef SandwichDataSourceError
+
+```C++
+typedef enum SandwichDataSourceError SandwichDataSourceError;
+```
+
+
+
+
+
+
+### enum SandwichErrorKind
+
+```C++
+enum SandwichErrorKind {
+ SANDWICH_ERRORKIND_API = 0,
+ SANDWICH_ERRORKIND_CONFIGURATION = 1,
+ SANDWICH_ERRORKIND_TLS_CONFIGURATION = 2,
+ SANDWICH_ERRORKIND_CERTIFICATE = 3,
+ SANDWICH_ERRORKIND_SYSTEM = 4,
+ SANDWICH_ERRORKIND_SOCKET = 5,
+ SANDWICH_ERRORKIND_PROTOBUF = 6,
+ SANDWICH_ERRORKIND_PRIVATE_KEY = 7,
+ SANDWICH_ERRORKIND_ASN1 = 8,
+ SANDWICH_ERRORKIND_DATA_SOURCE = 9,
+ SANDWICH_ERRORKIND_KEM = 10,
+ SANDWICH_ERRORKIND_HANDSHAKE = 11,
+ SANDWICH_ERRORKIND_TUNNEL = 12,
+ SANDWICH_ERRORKIND_ALPN = 13,
+ SANDWICH_ERRORKIND_IO = 14
+};
+```
+
+
+
+
+
+
+### typedef SandwichErrorKind
+
+```C++
+typedef enum SandwichErrorKind SandwichErrorKind;
+```
+
+
+
+
+
+
+### enum SandwichHandshakeError
+
+```C++
+enum SandwichHandshakeError {
+ SANDWICH_HANDSHAKEERROR_INVALID_SERVER_NAME = 0,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_VERIFICATION_FAILED = 1,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_EXPIRED = 2,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_REVOKED = 3,
+ SANDWICH_HANDSHAKEERROR_INVALID_CERTIFICATE = 4,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_SIGNATURE_VERIFICATION_FAILED = 5,
+ SANDWICH_HANDSHAKEERROR_UNKNOWN_ERROR = 6,
+ SANDWICH_HANDSHAKEERROR_DEPTH_EXCEEDED = 7,
+ SANDWICH_HANDSHAKEERROR_UNSUPPORTED_PROTOCOL = 8,
+ SANDWICH_HANDSHAKEERROR_NO_SHARED_CIPHER = 9,
+ SANDWICH_HANDSHAKEERROR_NO_SUITABLE_KEY_SHARE = 10
+};
+```
+
+
+
+
+
+
+### typedef SandwichHandshakeError
+
+```C++
+typedef enum SandwichHandshakeError SandwichHandshakeError;
+```
+
+
+
+
+
+
+### enum SandwichKEMError
+
+```C++
+enum SandwichKEMError {
+ SANDWICH_KEMERROR_INVALID = 0,
+ SANDWICH_KEMERROR_TOO_MANY = 1
+};
+```
+
+
+
+
+
+
+### typedef SandwichKEMError
+
+```C++
+typedef enum SandwichKEMError SandwichKEMError;
+```
+
+
+
+
+
+
+### enum SandwichPrivateKeyError
+
+```C++
+enum SandwichPrivateKeyError {
+ SANDWICH_PRIVATEKEYERROR_MALFORMED = 0,
+ SANDWICH_PRIVATEKEYERROR_NOT_FOUND = 1,
+ SANDWICH_PRIVATEKEYERROR_UNKNOWN = 2,
+ SANDWICH_PRIVATEKEYERROR_UNSUPPORTED = 3,
+ SANDWICH_PRIVATEKEYERROR_NOT_SERVER = 4
+};
+```
+
+
+
+
+
+
+### typedef SandwichPrivateKeyError
+
+```C++
+typedef enum SandwichPrivateKeyError SandwichPrivateKeyError;
+```
+
+
+
+
+
+
+### enum SandwichProtobufError
+
+```C++
+enum SandwichProtobufError {
+ SANDWICH_PROTOBUFERROR_EMPTY = 0,
+ SANDWICH_PROTOBUFERROR_TOO_BIG = 1,
+ SANDWICH_PROTOBUFERROR_PARSE_FAILED = 2,
+ SANDWICH_PROTOBUFERROR_NULLPTR = 3,
+ SANDWICH_PROTOBUFERROR_INVALID_ARGUMENT = 4
+};
+```
+
+
+
+
+
+
+### typedef SandwichProtobufError
+
+```C++
+typedef enum SandwichProtobufError SandwichProtobufError;
+```
+
+
+
+
+
+
+### enum SandwichSocketError
+
+```C++
+enum SandwichSocketError {
+ SANDWICH_SOCKETERROR_BAD_FD = 0,
+ SANDWICH_SOCKETERROR_CREATION_FAILED = 1,
+ SANDWICH_SOCKETERROR_BAD_NETADDR = 2,
+ SANDWICH_SOCKETERROR_NETADDR_UNKNOWN = 3,
+ SANDWICH_SOCKETERROR_FSTAT_FAILED = 4,
+ SANDWICH_SOCKETERROR_NOT_SOCK = 5,
+ SANDWICH_SOCKETERROR_GETSOCKNAME_FAILED = 6,
+ SANDWICH_SOCKETERROR_SETSOCKOPT_FAILED = 7,
+ SANDWICH_SOCKETERROR_INVALID_AI_FAMILY = 8
+};
+```
+
+
+
+
+
+
+### typedef SandwichSocketError
+
+```C++
+typedef enum SandwichSocketError SandwichSocketError;
+```
+
+
+
+
+
+
+### enum SandwichSystemError
+
+```C++
+enum SandwichSystemError {
+ SANDWICH_SYSTEMERROR_MEMORY = 0,
+ SANDWICH_SYSTEMERROR_INTEGER_OVERFLOW = 1,
+ SANDWICH_SYSTEMERROR_BACKEND = 2
+};
+```
+
+
+
+
+
+
+### typedef SandwichSystemError
+
+```C++
+typedef enum SandwichSystemError SandwichSystemError;
+```
+
+
+
+
+
+
+### enum SandwichTLSConfigurationError
+
+```C++
+enum SandwichTLSConfigurationError {
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION = 0,
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID_CASE = 1,
+ SANDWICH_TLSCONFIGURATIONERROR_EMPTY = 2,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_PROTOCOL_VERSION = 3,
+ SANDWICH_TLSCONFIGURATIONERROR_PRIVATE_KEY_INCONSISTENT_WITH_CERTIFICATE = 4,
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID = 5,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CIPHERSUITE = 6,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CONTROL_CHARACTERS = 7
+};
+```
+
+
+
+
+
+
+### typedef SandwichTLSConfigurationError
+
+```C++
+typedef enum SandwichTLSConfigurationError SandwichTLSConfigurationError;
+```
+
+
+
+
+
+
+### enum SandwichTunnelError
+
+```C++
+enum SandwichTunnelError {
+ SANDWICH_TUNNELERROR_INVALID = 0,
+ SANDWICH_TUNNELERROR_VERIFIER = 1,
+ SANDWICH_TUNNELERROR_UNKNOWN = 2
+};
+```
+
+
+
+
+
+
+### typedef SandwichTunnelError
+
+```C++
+typedef enum SandwichTunnelError SandwichTunnelError;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/error_codes.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/error__codes_8h_source.md b/assets/.doxy/cAPI/cAPI/error__codes_8h_source.md
new file mode 100755
index 00000000..ba5d9625
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/error__codes_8h_source.md
@@ -0,0 +1,178 @@
+
+
+# File error\_codes.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**error\_codes.h**](error__codes_8h.md)
+
+[Go to the documentation of this file](error__codes_8h.md)
+
+```C++
+
+// Copyright 2023 SandboxAQ
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+enum SandwichAPIError {
+ SANDWICH_APIERROR_CONFIGURATION = 0,
+ SANDWICH_APIERROR_SOCKET = 1,
+ SANDWICH_APIERROR_TUNNEL = 2,
+};
+typedef enum SandwichAPIError SandwichAPIError;
+
+enum SandwichConfigurationError {
+ SANDWICH_CONFIGURATIONERROR_INVALID_IMPLEMENTATION = 0,
+ SANDWICH_CONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION = 1,
+ SANDWICH_CONFIGURATIONERROR_INVALID = 2,
+ SANDWICH_CONFIGURATIONERROR_INVALID_LISTENER = 3,
+};
+typedef enum SandwichConfigurationError SandwichConfigurationError;
+
+enum SandwichProtobufError {
+ SANDWICH_PROTOBUFERROR_EMPTY = 0,
+ SANDWICH_PROTOBUFERROR_TOO_BIG = 1,
+ SANDWICH_PROTOBUFERROR_PARSE_FAILED = 2,
+ SANDWICH_PROTOBUFERROR_NULLPTR = 3,
+ SANDWICH_PROTOBUFERROR_INVALID_ARGUMENT = 4,
+};
+typedef enum SandwichProtobufError SandwichProtobufError;
+
+enum SandwichTLSConfigurationError {
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION = 0,
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID_CASE = 1,
+ SANDWICH_TLSCONFIGURATIONERROR_EMPTY = 2,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_PROTOCOL_VERSION = 3,
+ SANDWICH_TLSCONFIGURATIONERROR_PRIVATE_KEY_INCONSISTENT_WITH_CERTIFICATE = 4,
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID = 5,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CIPHERSUITE = 6,
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CONTROL_CHARACTERS = 7,
+};
+typedef enum SandwichTLSConfigurationError SandwichTLSConfigurationError;
+
+enum SandwichCertificateError {
+ SANDWICH_CERTIFICATEERROR_MALFORMED = 0,
+ SANDWICH_CERTIFICATEERROR_EXPIRED = 1,
+ SANDWICH_CERTIFICATEERROR_NOT_FOUND = 2,
+ SANDWICH_CERTIFICATEERROR_UNKNOWN = 3,
+ SANDWICH_CERTIFICATEERROR_UNSUPPORTED = 4,
+};
+typedef enum SandwichCertificateError SandwichCertificateError;
+
+enum SandwichPrivateKeyError {
+ SANDWICH_PRIVATEKEYERROR_MALFORMED = 0,
+ SANDWICH_PRIVATEKEYERROR_NOT_FOUND = 1,
+ SANDWICH_PRIVATEKEYERROR_UNKNOWN = 2,
+ SANDWICH_PRIVATEKEYERROR_UNSUPPORTED = 3,
+ SANDWICH_PRIVATEKEYERROR_NOT_SERVER = 4,
+};
+typedef enum SandwichPrivateKeyError SandwichPrivateKeyError;
+
+enum SandwichASN1Error {
+ SANDWICH_ASN1ERROR_INVALID_FORMAT = 0,
+ SANDWICH_ASN1ERROR_MALFORMED = 1,
+};
+typedef enum SandwichASN1Error SandwichASN1Error;
+
+enum SandwichALPNError {
+ SANDWICH_ALPNERROR_LENGTH_ERROR = 0,
+ SANDWICH_ALPNERROR_INVALID_STRING = 1,
+};
+typedef enum SandwichALPNError SandwichALPNError;
+
+enum SandwichDataSourceError {
+ SANDWICH_DATASOURCEERROR_EMPTY = 0,
+ SANDWICH_DATASOURCEERROR_INVALID_CASE = 1,
+ SANDWICH_DATASOURCEERROR_NOT_FOUND = 2,
+};
+typedef enum SandwichDataSourceError SandwichDataSourceError;
+
+enum SandwichKEMError {
+ SANDWICH_KEMERROR_INVALID = 0,
+ SANDWICH_KEMERROR_TOO_MANY = 1,
+};
+typedef enum SandwichKEMError SandwichKEMError;
+
+enum SandwichSystemError {
+ SANDWICH_SYSTEMERROR_MEMORY = 0,
+ SANDWICH_SYSTEMERROR_INTEGER_OVERFLOW = 1,
+ SANDWICH_SYSTEMERROR_BACKEND = 2,
+};
+typedef enum SandwichSystemError SandwichSystemError;
+
+enum SandwichSocketError {
+ SANDWICH_SOCKETERROR_BAD_FD = 0,
+ SANDWICH_SOCKETERROR_CREATION_FAILED = 1,
+ SANDWICH_SOCKETERROR_BAD_NETADDR = 2,
+ SANDWICH_SOCKETERROR_NETADDR_UNKNOWN = 3,
+ SANDWICH_SOCKETERROR_FSTAT_FAILED = 4,
+ SANDWICH_SOCKETERROR_NOT_SOCK = 5,
+ SANDWICH_SOCKETERROR_GETSOCKNAME_FAILED = 6,
+ SANDWICH_SOCKETERROR_SETSOCKOPT_FAILED = 7,
+ SANDWICH_SOCKETERROR_INVALID_AI_FAMILY = 8,
+};
+typedef enum SandwichSocketError SandwichSocketError;
+
+enum SandwichHandshakeError {
+ SANDWICH_HANDSHAKEERROR_INVALID_SERVER_NAME = 0,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_VERIFICATION_FAILED = 1,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_EXPIRED = 2,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_REVOKED = 3,
+ SANDWICH_HANDSHAKEERROR_INVALID_CERTIFICATE = 4,
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_SIGNATURE_VERIFICATION_FAILED = 5,
+ SANDWICH_HANDSHAKEERROR_UNKNOWN_ERROR = 6,
+ SANDWICH_HANDSHAKEERROR_DEPTH_EXCEEDED = 7,
+ SANDWICH_HANDSHAKEERROR_UNSUPPORTED_PROTOCOL = 8,
+ SANDWICH_HANDSHAKEERROR_NO_SHARED_CIPHER = 9,
+ SANDWICH_HANDSHAKEERROR_NO_SUITABLE_KEY_SHARE = 10,
+};
+typedef enum SandwichHandshakeError SandwichHandshakeError;
+
+enum SandwichTunnelError {
+ SANDWICH_TUNNELERROR_INVALID = 0,
+ SANDWICH_TUNNELERROR_VERIFIER = 1,
+ SANDWICH_TUNNELERROR_UNKNOWN = 2,
+};
+typedef enum SandwichTunnelError SandwichTunnelError;
+
+enum SandwichErrorKind {
+ SANDWICH_ERRORKIND_API = 0,
+ SANDWICH_ERRORKIND_CONFIGURATION = 1,
+ SANDWICH_ERRORKIND_TLS_CONFIGURATION = 2,
+ SANDWICH_ERRORKIND_CERTIFICATE = 3,
+ SANDWICH_ERRORKIND_SYSTEM = 4,
+ SANDWICH_ERRORKIND_SOCKET = 5,
+ SANDWICH_ERRORKIND_PROTOBUF = 6,
+ SANDWICH_ERRORKIND_PRIVATE_KEY = 7,
+ SANDWICH_ERRORKIND_ASN1 = 8,
+ SANDWICH_ERRORKIND_DATA_SOURCE = 9,
+ SANDWICH_ERRORKIND_KEM = 10,
+ SANDWICH_ERRORKIND_HANDSHAKE = 11,
+ SANDWICH_ERRORKIND_TUNNEL = 12,
+ SANDWICH_ERRORKIND_ALPN = 13,
+ SANDWICH_ERRORKIND_IO = 14,
+};
+typedef enum SandwichErrorKind SandwichErrorKind;
+
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/export_8h.md b/assets/.doxy/cAPI/cAPI/export_8h.md
new file mode 100755
index 00000000..04321610
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/export_8h.md
@@ -0,0 +1,100 @@
+
+
+# File export.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**export.h**](export_8h.md)
+
+[Go to the source code of this file](export_8h_source.md)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Macros
+
+| Type | Name |
+| ---: | :--- |
+| define | [**SANDWICH\_API**](export_8h.md#define-sandwich_api)
|
+
+## Macro Definition Documentation
+
+
+
+
+
+### define SANDWICH\_API
+
+```C++
+#define SANDWICH_API
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/export.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/export_8h_source.md b/assets/.doxy/cAPI/cAPI/export_8h_source.md
new file mode 100755
index 00000000..ef66aaf1
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/export_8h_source.md
@@ -0,0 +1,23 @@
+
+
+# File export.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**export.h**](export_8h.md)
+
+[Go to the documentation of this file](export_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+#pragma once
+
+#if (defined(__clang__) || (_GNUC__ >= 4))
+#define SANDWICH_API __attribute__((visibility("default")))
+#else
+#define SANDWICH_API
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/files.md b/assets/.doxy/cAPI/cAPI/files.md
new file mode 100755
index 00000000..3f5fc861
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/files.md
@@ -0,0 +1,19 @@
+
+# File List
+
+Here is a list of all files with brief descriptions:
+
+
+* **dir** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md)
+ * **dir** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md)
+ * **file** [**error.h**](error_8h.md) _Error handling for the Sandwich library._
+ * **file** [**error\_codes.h**](error__codes_8h.md) _Sandwich errors specification._
+ * **file** [**export.h**](export_8h.md)
+ * **file** [**io.h**](io_8h.md) _I/O abstraction for Sandwich._
+ * **file** [**ioerrors.h**](ioerrors_8h.md) _Sandwich I/O errors specification._
+ * **file** [**lib.h**](lib_8h.md) _Top-level context for the Sandwich library._
+ * **file** [**listener.h**](listener_8h.md) _Sandwich C library, on top of the Rust implementation._
+ * **file** [**sandwich.h**](sandwich_8h.md) _Sandwich C library, on top of the Rust implementation._
+ * **file** [**tunnel.h**](tunnel_8h.md) _Sandwich Tunnel API._
+ * **file** [**tunnel\_types.h**](tunnel__types_8h.md) _Sandwich tunnel types and states specification._
+
diff --git a/assets/.doxy/cAPI/cAPI/functions.md b/assets/.doxy/cAPI/cAPI/functions.md
new file mode 100755
index 00000000..e5acbd1a
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/functions.md
@@ -0,0 +1,34 @@
+
+# Functions
+
+
+
+## s
+
+* **sandwich\_error\_free** ([**error.h**](error_8h.md))
+* **sandwich\_error\_stack\_str\_free** ([**error.h**](error_8h.md))
+* **sandwich\_error\_stack\_str\_new** ([**error.h**](error_8h.md))
+* **SandwichIOFlushFunction** ([**io.h**](io_8h.md))
+* **sandwich\_io\_client\_tcp\_new** ([**io.h**](io_8h.md))
+* **sandwich\_io\_owned\_free** ([**io.h**](io_8h.md))
+* **sandwich\_io\_socket\_wrap\_new** ([**io.h**](io_8h.md))
+* **sandwich\_lib\_context\_free** ([**lib.h**](lib_8h.md))
+* **sandwich\_lib\_context\_new** ([**lib.h**](lib_8h.md))
+* **sandwich\_listener\_accept** ([**listener.h**](listener_8h.md))
+* **sandwich\_listener\_close** ([**listener.h**](listener_8h.md))
+* **sandwich\_listener\_free** ([**listener.h**](listener_8h.md))
+* **sandwich\_listener\_listen** ([**listener.h**](listener_8h.md))
+* **sandwich\_listener\_new** ([**listener.h**](listener_8h.md))
+* **sandwich\_tunnel\_close** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_context\_free** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_context\_new** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_free** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_handshake** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_new** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_read** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_state** ([**tunnel.h**](tunnel_8h.md))
+* **sandwich\_tunnel\_write** ([**tunnel.h**](tunnel_8h.md))
+
+
+
+
diff --git a/assets/.doxy/cAPI/cAPI/hierarchy.md b/assets/.doxy/cAPI/cAPI/hierarchy.md
new file mode 100755
index 00000000..db3dd076
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/hierarchy.md
@@ -0,0 +1,12 @@
+
+# Class Hierarchy
+
+This inheritance list is sorted roughly, but not completely, alphabetically:
+
+
+* **struct** [**SandwichError**](structSandwichError.md) _An error code._
+* **struct** [**SandwichIO**](structSandwichIO.md) _A generic I/O interface._
+* **struct** [**SandwichIOOwned**](structSandwichIOOwned.md) _An IO owned by the Sandwich Library._
+* **struct** [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md) _A serialized_ `TunnelConfiguration` _message._
+* **struct** [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md) _A serialized_ `Configuration` _message._
+
diff --git a/assets/.doxy/cAPI/cAPI/io_8h.md b/assets/.doxy/cAPI/cAPI/io_8h.md
new file mode 100755
index 00000000..cde5ef0e
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/io_8h.md
@@ -0,0 +1,354 @@
+
+
+# File io.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**io.h**](io_8h.md)
+
+[Go to the source code of this file](io_8h_source.md)
+
+_I/O abstraction for Sandwich._
+
+* `#include `
+* `#include "sandwich_c/export.h"`
+* `#include "sandwich_c/ioerrors.h"`
+* `#include "sandwich_c/tunnel_types.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| struct | [**SandwichIO**](structSandwichIO.md)
_A generic I/O interface._ |
+| struct | [**SandwichIOOwned**](structSandwichIOOwned.md)
_An IO owned by the Sandwich Library._ |
+
+
+## Public Types
+
+| Type | Name |
+| ---: | :--- |
+| typedef [**SandwichIOFlushFunction**](io_8h.md#function-sandwichioflushfunction) \* | [**SandwichIOFlushFunctionPtr**](#typedef-sandwichioflushfunctionptr)
|
+| typedef size\_t() | [**SandwichIOReadFunction**](#typedef-sandwichioreadfunction)
_Read function for the I/O interface._ |
+| typedef [**SandwichIOReadFunction**](io_8h.md#typedef-sandwichioreadfunction) \* | [**SandwichIOReadFunctionPtr**](#typedef-sandwichioreadfunctionptr)
|
+| typedef size\_t() | [**SandwichIOWriteFunction**](#typedef-sandwichiowritefunction)
_Write function for the I/O interface._ |
+| typedef [**SandwichIOWriteFunction**](io_8h.md#typedef-sandwichiowritefunction) \* | [**SandwichIOWriteFunctionPtr**](#typedef-sandwichiowritefunctionptr)
|
+| typedef void() | [**SandwichOwnedIOFreeFunction**](#typedef-sandwichownediofreefunction)
_A destructor function for owned I/O interface._ |
+| typedef [**SandwichOwnedIOFreeFunction**](io_8h.md#typedef-sandwichownediofreefunction) \* | [**SandwichOwnedIOFreeFunctionPtr**](#typedef-sandwichownediofreefunctionptr)
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+| enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror)() | [**SandwichIOFlushFunction**](#function-sandwichioflushfunction) (void \* uarg)
_Flush function for the I/O interface._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror) | [**sandwich\_io\_client\_tcp\_new**](#function-sandwich_io_client_tcp_new) (const char \* hostname, uint16\_t port, bool async, struct [**SandwichIOOwned**](structSandwichIOOwned.md) \*\* ownedIO)
_Creates a TCP based IO object to be used for a client tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_io\_owned\_free**](#function-sandwich_io_owned_free) (struct [**SandwichIOOwned**](structSandwichIOOwned.md) \* ownedIO)
_Frees a_ [_**SandwichIOOwned**_](structSandwichIOOwned.md) _object created by one of the sandwich\_io\_\*\_new() functions._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror) | [**sandwich\_io\_socket\_wrap\_new**](#function-sandwich_io_socket_wrap_new) (int fd, struct [**SandwichIOOwned**](structSandwichIOOwned.md) \*\* ownedIO)
_Creates an IO object that wraps a UNIX socket._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types Documentation
+
+
+
+
+### typedef SandwichIOFlushFunctionPtr
+
+```C++
+typedef SandwichIOFlushFunction* SandwichIOFlushFunctionPtr;
+```
+
+
+
+
+
+
+### typedef SandwichIOReadFunction
+
+_Read function for the I/O interface._
+```C++
+typedef size_t() SandwichIOReadFunction(void *uarg, void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err);
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `uarg` User opaque argument.
+* `buf` Destination buffer.
+* `count` Amount of bytes to read.
+* `tunnel_state` Current state of the tunnel.
+* `err` Error, if any.
+
+
+
+**Returns:**
+
+The amount of bytes successfully read, or 0.
+
+
+
+
+
+
+
+
+
+### typedef SandwichIOReadFunctionPtr
+
+```C++
+typedef SandwichIOReadFunction* SandwichIOReadFunctionPtr;
+```
+
+
+
+
+
+
+### typedef SandwichIOWriteFunction
+
+_Write function for the I/O interface._
+```C++
+typedef size_t() SandwichIOWriteFunction(void *uarg, const void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err);
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `uarg` User opaque argument.
+* `buf` Source buffer.
+* `count` Amount of bytes to write.
+* `tunnel_state` Current state of the tunnel.
+* `err` Error, if any.
+
+
+
+**Returns:**
+
+The amount of bytes successfully written, or 0.
+
+
+
+
+
+
+
+
+
+### typedef SandwichIOWriteFunctionPtr
+
+```C++
+typedef SandwichIOWriteFunction* SandwichIOWriteFunctionPtr;
+```
+
+
+
+
+
+
+### typedef SandwichOwnedIOFreeFunction
+
+```C++
+typedef void() SandwichOwnedIOFreeFunction(struct SandwichIO *io);
+```
+
+
+
+
+
+
+### typedef SandwichOwnedIOFreeFunctionPtr
+
+```C++
+typedef SandwichOwnedIOFreeFunction* SandwichOwnedIOFreeFunctionPtr;
+```
+
+
+
+## Public Functions Documentation
+
+
+
+
+### function SandwichIOFlushFunction
+
+_Flush function for the I/O interface._
+```C++
+enum SandwichIOError () SandwichIOFlushFunction (
+ void * uarg
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `uarg` User opaque argument.
+
+
+
+**Returns:**
+
+IOERROR\_OK if success, else an IO error.
+
+
+
+
+
+
+
+
+
+### function sandwich\_io\_client\_tcp\_new
+
+_Creates a TCP based IO object to be used for a client tunnel._
+```C++
+SANDWICH_API enum SandwichIOError sandwich_io_client_tcp_new (
+ const char * hostname,
+ uint16_t port,
+ bool async,
+ struct SandwichIOOwned ** ownedIO
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `hostname` the hostname of the target server.
+* `port` the port number of the target server.
+* `async` indicates whether sockets should be non-blocking or not.
+* `ownedIO` the created TCP based sandwich owned IO object.
+
+
+
+**Returns:**
+
+IOERROR\_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+
+### function sandwich\_io\_owned\_free
+
+```C++
+SANDWICH_API void sandwich_io_owned_free (
+ struct SandwichIOOwned * ownedIO
+)
+```
+
+
+
+
+
+
+### function sandwich\_io\_socket\_wrap\_new
+
+_Creates an IO object that wraps a UNIX socket._
+```C++
+SANDWICH_API enum SandwichIOError sandwich_io_socket_wrap_new (
+ int fd,
+ struct SandwichIOOwned ** ownedIO
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `fd` the file descriptor of the unix socket.
+* `ownedIO` the created UNIX socket sandwich owned IO object. The caller is responsible for freeing that object with [**sandwich\_io\_owned\_free**](io_8h.md#function-sandwich_io_owned_free).
+
+
+
+**Returns:**
+
+IOERROR\_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/io.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/io_8h_source.md b/assets/.doxy/cAPI/cAPI/io_8h_source.md
new file mode 100755
index 00000000..9b67e478
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/io_8h_source.md
@@ -0,0 +1,76 @@
+
+
+# File io.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**io.h**](io_8h.md)
+
+[Go to the documentation of this file](io_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+
+#pragma once
+
+#include
+
+#include "sandwich_c/export.h"
+#include "sandwich_c/ioerrors.h"
+#include "sandwich_c/tunnel_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef size_t(SandwichIOReadFunction)(void *uarg, void *buf, size_t count,
+ enum SandwichTunnelState tunnel_state,
+ enum SandwichIOError *err);
+typedef SandwichIOReadFunction *SandwichIOReadFunctionPtr;
+
+typedef size_t(SandwichIOWriteFunction)(void *uarg, const void *buf,
+ size_t count,
+ enum SandwichTunnelState tunnel_state,
+ enum SandwichIOError *err);
+typedef SandwichIOWriteFunction *SandwichIOWriteFunctionPtr;
+
+typedef enum SandwichIOError(SandwichIOFlushFunction)(void *uarg);
+typedef SandwichIOFlushFunction *SandwichIOFlushFunctionPtr;
+
+struct SandwichIO {
+ SandwichIOReadFunctionPtr read;
+
+ SandwichIOWriteFunctionPtr write;
+
+ SandwichIOFlushFunctionPtr flush;
+
+ void *uarg;
+};
+
+typedef void(SandwichOwnedIOFreeFunction)(struct SandwichIO *io);
+typedef SandwichOwnedIOFreeFunction *SandwichOwnedIOFreeFunctionPtr;
+
+struct SandwichIOOwned {
+ // \brief the io which is owned by Sandwich.
+ struct SandwichIO *io;
+
+ // \brief the function used to free the owned io.
+ SandwichOwnedIOFreeFunctionPtr freeptr;
+};
+
+SANDWICH_API enum SandwichIOError
+sandwich_io_client_tcp_new(const char *hostname, uint16_t port, bool async,
+ struct SandwichIOOwned **ownedIO);
+
+SANDWICH_API enum SandwichIOError
+sandwich_io_socket_wrap_new(int fd, struct SandwichIOOwned **ownedIO);
+
+SANDWICH_API void sandwich_io_owned_free(struct SandwichIOOwned *ownedIO);
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/ioerrors_8h.md b/assets/.doxy/cAPI/cAPI/ioerrors_8h.md
new file mode 100755
index 00000000..0defe2d1
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/ioerrors_8h.md
@@ -0,0 +1,121 @@
+
+
+# File ioerrors.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**ioerrors.h**](ioerrors_8h.md)
+
+[Go to the source code of this file](ioerrors_8h_source.md)
+
+_Sandwich I/O errors specification._
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types
+
+| Type | Name |
+| ---: | :--- |
+| enum | [**SandwichIOError**](#enum-sandwichioerror)
_Enum IOError._ |
+| typedef enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror) | [**SandwichIOError**](#typedef-sandwichioerror)
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types Documentation
+
+
+
+
+### enum SandwichIOError
+
+```C++
+enum SandwichIOError {
+ SANDWICH_IOERROR_OK = 0,
+ SANDWICH_IOERROR_IN_PROGRESS = 1,
+ SANDWICH_IOERROR_WOULD_BLOCK = 2,
+ SANDWICH_IOERROR_REFUSED = 3,
+ SANDWICH_IOERROR_CLOSED = 4,
+ SANDWICH_IOERROR_INVALID = 5,
+ SANDWICH_IOERROR_UNKNOWN = 6,
+ SANDWICH_IOERROR_SYSTEM_ERROR = 7,
+ SANDWICH_IOERROR_ADDRESS_IN_USE = 8
+};
+```
+
+
+
+
+
+
+### typedef SandwichIOError
+
+```C++
+typedef enum SandwichIOError SandwichIOError;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/ioerrors.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/ioerrors_8h_source.md b/assets/.doxy/cAPI/cAPI/ioerrors_8h_source.md
new file mode 100755
index 00000000..a89a986f
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/ioerrors_8h_source.md
@@ -0,0 +1,51 @@
+
+
+# File ioerrors.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**ioerrors.h**](ioerrors_8h.md)
+
+[Go to the documentation of this file](ioerrors_8h.md)
+
+```C++
+
+// Copyright 2023 SandboxAQ
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+enum SandwichIOError {
+ SANDWICH_IOERROR_OK = 0,
+ SANDWICH_IOERROR_IN_PROGRESS = 1,
+ SANDWICH_IOERROR_WOULD_BLOCK = 2,
+ SANDWICH_IOERROR_REFUSED = 3,
+ SANDWICH_IOERROR_CLOSED = 4,
+ SANDWICH_IOERROR_INVALID = 5,
+ SANDWICH_IOERROR_UNKNOWN = 6,
+ SANDWICH_IOERROR_SYSTEM_ERROR = 7,
+ SANDWICH_IOERROR_ADDRESS_IN_USE = 8,
+};
+typedef enum SandwichIOError SandwichIOError;
+
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/lib_8h.md b/assets/.doxy/cAPI/cAPI/lib_8h.md
new file mode 100755
index 00000000..24a3dcbe
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/lib_8h.md
@@ -0,0 +1,140 @@
+
+
+# File lib.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**lib.h**](lib_8h.md)
+
+[Go to the source code of this file](lib_8h_source.md)
+
+_Top-level context for the Sandwich library._
+
+* `#include "sandwich_c/export.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_lib\_context\_free**](#function-sandwich_lib_context_free) (struct SandwichContext \* sw)
_Free a top-level Sandwich context._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) struct SandwichContext \* | [**sandwich\_lib\_context\_new**](#function-sandwich_lib_context_new) (void)
_Create a top-level Sandwich context._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions Documentation
+
+
+
+
+### function sandwich\_lib\_context\_free
+
+_Free a top-level Sandwich context._
+```C++
+SANDWICH_API void sandwich_lib_context_free (
+ struct SandwichContext * sw
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `sw` Top-level Sandwich context to free.
+
+NULL for `sw` is allowed.
+
+
+
+
+
+
+### function sandwich\_lib\_context\_new
+
+_Create a top-level Sandwich context._
+```C++
+SANDWICH_API struct SandwichContext * sandwich_lib_context_new (
+ void
+)
+```
+
+
+
+
+
+**Returns:**
+
+A new top-level Sandwich context.
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/lib.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/lib_8h_source.md b/assets/.doxy/cAPI/cAPI/lib_8h_source.md
new file mode 100755
index 00000000..eddd176b
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/lib_8h_source.md
@@ -0,0 +1,34 @@
+
+
+# File lib.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**lib.h**](lib_8h.md)
+
+[Go to the documentation of this file](lib_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+#pragma once
+
+#include "sandwich_c/export.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+struct SandwichContext;
+
+SANDWICH_API struct SandwichContext *sandwich_lib_context_new(void);
+
+SANDWICH_API void sandwich_lib_context_free(struct SandwichContext *sw);
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/links.md b/assets/.doxy/cAPI/cAPI/links.md
new file mode 100755
index 00000000..7f8884e6
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/links.md
@@ -0,0 +1,20 @@
+ - [Related Pages](pages.md)
+ - [Modules](modules.md)
+ - [Class List](annotated.md)
+ - [Namespace ListNamespace List](namespaces.md)
+ - [Namespace Members](namespace_members.md)
+ - [Namespace Member Functions](namespace_member_functions.md)
+ - [Namespace Member Variables](namespace_member_variables.md)
+ - [Namespace Member Typedefs](namespace_member_typedefs.md)
+ - [Namespace Member Enumerations](namespace_member_enums.md)
+ - [Class Index](classes.md)
+ - [Class Hierarchy](hierarchy.md)
+ - [Class Members](class_members.md)
+ - [Class Member Functions](class_member_functions.md)
+ - [Class Member Variables](class_member_variables.md)
+ - [Class Member Typedefs](class_member_typedefs.md)
+ - [Class Member Enumerations](class_member_enums.md)
+ - [Files](files.md)
+ - [File Variables](variables.md)
+ - [File Functions](functions.md)
+ - [File Macros](macros.md)
diff --git a/assets/.doxy/cAPI/cAPI/listener_8h.md b/assets/.doxy/cAPI/cAPI/listener_8h.md
new file mode 100755
index 00000000..fa2ef7e1
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/listener_8h.md
@@ -0,0 +1,247 @@
+
+
+# File listener.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**listener.h**](listener_8h.md)
+
+[Go to the source code of this file](listener_8h_source.md)
+
+_Sandwich C library, on top of the Rust implementation._
+
+* `#include `
+* `#include "sandwich_c/export.h"`
+* `#include "sandwich_c/io.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror) | [**sandwich\_listener\_accept**](#function-sandwich_listener_accept) (struct SandwichListener \* listener, struct [**SandwichIOOwned**](structSandwichIOOwned.md) \*\* ownedIO)
_Prompts the Listener to start accepting connections._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_listener\_close**](#function-sandwich_listener_close) (struct SandwichListener \* listener)
_Closes the listener to new connections._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_listener\_free**](#function-sandwich_listener_free) (struct SandwichListener \* listener)
_Frees the given listener._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichIOError**](ioerrors_8h.md#enum-sandwichioerror) | [**sandwich\_listener\_listen**](#function-sandwich_listener_listen) (struct SandwichListener \* listener)
_Causes the Listener to start listening for connections._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) struct [**SandwichError**](structSandwichError.md) \* | [**sandwich\_listener\_new**](#function-sandwich_listener_new) (const void \* src, size\_t n, struct SandwichListener \*\* out)
_Creates a a new Listener object._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions Documentation
+
+
+
+
+### function sandwich\_listener\_accept
+
+_Prompts the Listener to start accepting connections._
+```C++
+SANDWICH_API enum SandwichIOError sandwich_listener_accept (
+ struct SandwichListener * listener,
+ struct SandwichIOOwned ** ownedIO
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `listener` the listener which should start accepting connections.
+* `ownedIO` the newly created OwnedIO struct containing the IO object to use with a tunnel. Null if an error occurs.
+
+
+
+**Returns:**
+
+IOERROR\_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+
+### function sandwich\_listener\_close
+
+_Closes the listener to new connections._
+```C++
+SANDWICH_API void sandwich_listener_close (
+ struct SandwichListener * listener
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `listener` the listener which should close.
+
+
+
+
+
+
+
+
+### function sandwich\_listener\_free
+
+_Frees the given listener._
+```C++
+SANDWICH_API void sandwich_listener_free (
+ struct SandwichListener * listener
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `listener` the listener which should start accepting connections.
+
+
+
+
+
+
+
+
+### function sandwich\_listener\_listen
+
+_Causes the Listener to start listening for connections._
+```C++
+SANDWICH_API enum SandwichIOError sandwich_listener_listen (
+ struct SandwichListener * listener
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `listener` The listener object that should start listening for new connections.
+
+
+
+**Returns:**
+
+IOERROR\_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+
+### function sandwich\_listener\_new
+
+_Creates a a new Listener object._
+```C++
+SANDWICH_API struct SandwichError * sandwich_listener_new (
+ const void * src,
+ size_t n,
+ struct SandwichListener ** out
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `src` a serialized `ListenerConfiguration` protobuf message.
+* `n` the length of src.
+* `out` points to the newly created listener.
+
+
+
+**Returns:**
+
+Error, if any.
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/listener.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/listener_8h_source.md b/assets/.doxy/cAPI/cAPI/listener_8h_source.md
new file mode 100755
index 00000000..639cf428
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/listener_8h_source.md
@@ -0,0 +1,47 @@
+
+
+# File listener.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**listener.h**](listener_8h.md)
+
+[Go to the documentation of this file](listener_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+
+#pragma once
+
+#include
+
+#include "sandwich_c/export.h"
+#include "sandwich_c/io.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct SandwichListener;
+
+SANDWICH_API struct SandwichError *
+sandwich_listener_new(const void *src, size_t n, struct SandwichListener **out);
+
+SANDWICH_API enum SandwichIOError
+sandwich_listener_listen(struct SandwichListener *listener);
+
+SANDWICH_API enum SandwichIOError
+sandwich_listener_accept(struct SandwichListener *listener,
+ struct SandwichIOOwned **ownedIO);
+
+SANDWICH_API void sandwich_listener_close(struct SandwichListener *listener);
+
+SANDWICH_API void sandwich_listener_free(struct SandwichListener *listener);
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/macros.md b/assets/.doxy/cAPI/cAPI/macros.md
new file mode 100755
index 00000000..a661d086
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/macros.md
@@ -0,0 +1,12 @@
+
+# Macros
+
+
+
+## s
+
+* **SANDWICH\_API** ([**export.h**](export_8h.md))
+
+
+
+
diff --git a/assets/.doxy/cAPI/cAPI/modules.md b/assets/.doxy/cAPI/cAPI/modules.md
new file mode 100755
index 00000000..754d90ee
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/modules.md
@@ -0,0 +1,7 @@
+
+# Modules
+
+
+No modules found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespace_member_enums.md b/assets/.doxy/cAPI/cAPI/namespace_member_enums.md
new file mode 100755
index 00000000..d2ea8ec9
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespace_member_enums.md
@@ -0,0 +1,7 @@
+
+# Namespace Member Enums
+
+
+Nothing related to **Namespace Member Enums** found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespace_member_functions.md b/assets/.doxy/cAPI/cAPI/namespace_member_functions.md
new file mode 100755
index 00000000..23df1e59
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespace_member_functions.md
@@ -0,0 +1,7 @@
+
+# Namespace Member Functions
+
+
+Nothing related to **Namespace Member Functions** found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespace_member_typedefs.md b/assets/.doxy/cAPI/cAPI/namespace_member_typedefs.md
new file mode 100755
index 00000000..01e32733
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespace_member_typedefs.md
@@ -0,0 +1,7 @@
+
+# Namespace Member Typedefs
+
+
+Nothing related to **Namespace Member Typedefs** found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespace_member_variables.md b/assets/.doxy/cAPI/cAPI/namespace_member_variables.md
new file mode 100755
index 00000000..d364184e
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespace_member_variables.md
@@ -0,0 +1,7 @@
+
+# Namespace Member Variables
+
+
+Nothing related to **Namespace Member Variables** found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespace_members.md b/assets/.doxy/cAPI/cAPI/namespace_members.md
new file mode 100755
index 00000000..33cbc51f
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespace_members.md
@@ -0,0 +1,7 @@
+
+# Namespace Members
+
+
+Nothing related to **Namespace Members** found.
+
+
diff --git a/assets/.doxy/cAPI/cAPI/namespaces.md b/assets/.doxy/cAPI/cAPI/namespaces.md
new file mode 100755
index 00000000..c385cb8a
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/namespaces.md
@@ -0,0 +1,7 @@
+
+# Namespace List
+
+Here is a list of all namespaces with brief descriptions:
+
+
+
diff --git a/assets/.doxy/cAPI/cAPI/pages.md b/assets/.doxy/cAPI/cAPI/pages.md
new file mode 100755
index 00000000..0bd9caa0
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/pages.md
@@ -0,0 +1,6 @@
+
+# Related Pages
+
+Here is a list of all related documentation pages:
+
+
diff --git a/assets/.doxy/cAPI/cAPI/sandwich_8h.md b/assets/.doxy/cAPI/cAPI/sandwich_8h.md
new file mode 100755
index 00000000..749f1b53
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/sandwich_8h.md
@@ -0,0 +1,86 @@
+
+
+# File sandwich.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**sandwich.h**](sandwich_8h.md)
+
+[Go to the source code of this file](sandwich_8h_source.md)
+
+_Sandwich C library, on top of the Rust implementation._
+
+* `#include "sandwich_c/error.h"`
+* `#include "sandwich_c/io.h"`
+* `#include "sandwich_c/lib.h"`
+* `#include "sandwich_c/listener.h"`
+* `#include "sandwich_c/tunnel.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/sandwich.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/sandwich_8h_source.md b/assets/.doxy/cAPI/cAPI/sandwich_8h_source.md
new file mode 100755
index 00000000..b101935f
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/sandwich_8h_source.md
@@ -0,0 +1,24 @@
+
+
+# File sandwich.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**sandwich.h**](sandwich_8h.md)
+
+[Go to the documentation of this file](sandwich_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+
+#pragma once
+
+#include "sandwich_c/error.h"
+#include "sandwich_c/io.h"
+#include "sandwich_c/lib.h"
+#include "sandwich_c/listener.h"
+#include "sandwich_c/tunnel.h"
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/structSandwichError.md b/assets/.doxy/cAPI/cAPI/structSandwichError.md
new file mode 100755
index 00000000..493d52a4
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/structSandwichError.md
@@ -0,0 +1,136 @@
+
+
+# Struct SandwichError
+
+
+
+[**ClassList**](annotated.md) **>** [**SandwichError**](structSandwichError.md)
+
+
+
+_An error code._
+
+* `#include `
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| int | [**code**](#variable-code)
_The error code._ |
+| struct [**SandwichError**](structSandwichError.md) \* | [**details**](#variable-details)
_The encapsulated error._ |
+| [**SandwichErrorKind**](error__codes_8h.md#enum-sandwicherrorkind) | [**kind**](#variable-kind)
_The error kind. See error::ErrorKind enum._ |
+| const char \* | [**msg**](#variable-msg)
_An optional error string._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable code
+
+```C++
+int SandwichError::code;
+```
+
+
+
+
+
+
+### variable details
+
+```C++
+struct SandwichError* SandwichError::details;
+```
+
+
+
+
+
+
+### variable kind
+
+```C++
+SandwichErrorKind SandwichError::kind;
+```
+
+
+
+
+
+
+### variable msg
+
+```C++
+const char* SandwichError::msg;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/error.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/structSandwichIO.md b/assets/.doxy/cAPI/cAPI/structSandwichIO.md
new file mode 100755
index 00000000..b7fe54a8
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/structSandwichIO.md
@@ -0,0 +1,141 @@
+
+
+# Struct SandwichIO
+
+
+
+[**ClassList**](annotated.md) **>** [**SandwichIO**](structSandwichIO.md)
+
+
+
+_A generic I/O interface._
+
+* `#include `
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| [**SandwichIOFlushFunctionPtr**](io_8h.md#typedef-sandwichioflushfunctionptr) | [**flush**](#variable-flush)
_The flush function._ |
+| [**SandwichIOReadFunctionPtr**](io_8h.md#typedef-sandwichioreadfunctionptr) | [**read**](#variable-read)
_The read function._ |
+| void \* | [**uarg**](#variable-uarg)
_Opaque argument to forward to read, write and flush._ |
+| [**SandwichIOWriteFunctionPtr**](io_8h.md#typedef-sandwichiowritefunctionptr) | [**write**](#variable-write)
_The write function._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable flush
+
+_The flush function._
+```C++
+SandwichIOFlushFunctionPtr SandwichIO::flush;
+```
+
+
+
+`NULL` is a valid value for flush.
+
+
+
+
+
+
+### variable read
+
+```C++
+SandwichIOReadFunctionPtr SandwichIO::read;
+```
+
+
+
+
+
+
+### variable uarg
+
+```C++
+void* SandwichIO::uarg;
+```
+
+
+
+
+
+
+### variable write
+
+```C++
+SandwichIOWriteFunctionPtr SandwichIO::write;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/io.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/structSandwichIOOwned.md b/assets/.doxy/cAPI/cAPI/structSandwichIOOwned.md
new file mode 100755
index 00000000..f39e67f0
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/structSandwichIOOwned.md
@@ -0,0 +1,119 @@
+
+
+# Struct SandwichIOOwned
+
+
+
+[**ClassList**](annotated.md) **>** [**SandwichIOOwned**](structSandwichIOOwned.md)
+
+
+
+_An IO owned by the Sandwich Library._ [More...](#detailed-description)
+
+* `#include `
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| [**SandwichOwnedIOFreeFunctionPtr**](io_8h.md#typedef-sandwichownediofreefunctionptr) | [**freeptr**](#variable-freeptr)
|
+| struct [**SandwichIO**](structSandwichIO.md) \* | [**io**](#variable-io)
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# Detailed Description
+
+
+[**SandwichIOOwned**](structSandwichIOOwned.md) objects owns the underlying `io->uarg` object pointer, and provides a `freeptr` function that is responsible for destroying that object. [**SandwichIOOwned**](structSandwichIOOwned.md) must be freed by calling the [**sandwich\_io\_owned\_free**](io_8h.md#function-sandwich_io_owned_free) function. This is what is returned from sandwich\_io\_\*\_new functions.
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable freeptr
+
+```C++
+SandwichOwnedIOFreeFunctionPtr SandwichIOOwned::freeptr;
+```
+
+
+
+
+
+
+### variable io
+
+```C++
+struct SandwichIO* SandwichIOOwned::io;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/io.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/structSandwichTunnelConfigurationSerialized.md b/assets/.doxy/cAPI/cAPI/structSandwichTunnelConfigurationSerialized.md
new file mode 100755
index 00000000..25fd28c5
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/structSandwichTunnelConfigurationSerialized.md
@@ -0,0 +1,112 @@
+
+
+# Struct SandwichTunnelConfigurationSerialized
+
+
+
+[**ClassList**](annotated.md) **>** [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md)
+
+
+
+_A serialized_ `TunnelConfiguration` _message._
+
+* `#include `
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| size\_t | [**n**](#variable-n)
_Size of_ `src` _._ |
+| const void \* | [**src**](#variable-src)
_Buffer containing the serialized_ `TunnelConfiguration` _message._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable n
+
+```C++
+size_t SandwichTunnelConfigurationSerialized::n;
+```
+
+
+
+
+
+
+### variable src
+
+```C++
+const void* SandwichTunnelConfigurationSerialized::src;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/tunnel.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/structSandwichTunnelContextConfigurationSerialized.md b/assets/.doxy/cAPI/cAPI/structSandwichTunnelContextConfigurationSerialized.md
new file mode 100755
index 00000000..a8e113f6
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/structSandwichTunnelContextConfigurationSerialized.md
@@ -0,0 +1,112 @@
+
+
+# Struct SandwichTunnelContextConfigurationSerialized
+
+
+
+[**ClassList**](annotated.md) **>** [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md)
+
+
+
+_A serialized_ `Configuration` _message._
+
+* `#include `
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| size\_t | [**n**](#variable-n)
_Size of_ `src` _._ |
+| const void \* | [**src**](#variable-src)
_Buffer containing the serialized_ `Configuration` _message._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable n
+
+```C++
+size_t SandwichTunnelContextConfigurationSerialized::n;
+```
+
+
+
+
+
+
+### variable src
+
+```C++
+const void* SandwichTunnelContextConfigurationSerialized::src;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/tunnel.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/tunnel_8h.md b/assets/.doxy/cAPI/cAPI/tunnel_8h.md
new file mode 100755
index 00000000..ef2a2c26
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/tunnel_8h.md
@@ -0,0 +1,430 @@
+
+
+# File tunnel.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**tunnel.h**](tunnel_8h.md)
+
+[Go to the source code of this file](tunnel_8h_source.md)
+
+_Sandwich Tunnel API._
+
+* `#include `
+* `#include "sandwich_c/export.h"`
+* `#include "sandwich_c/io.h"`
+* `#include "sandwich_c/tunnel_types.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| struct | [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md)
_A serialized_ `TunnelConfiguration` _message._ |
+| struct | [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md)
_A serialized_ `Configuration` _message._ |
+
+
+
+
+
+
+## Public Attributes
+
+| Type | Name |
+| ---: | :--- |
+| struct [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md) | [**SandwichTunnelConfigurationVerifierEmpty**](#variable-sandwichtunnelconfigurationverifierempty)
_A tunnel configuration containing an empty Tunnel Verifier._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Functions
+
+| Type | Name |
+| ---: | :--- |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_tunnel\_close**](#function-sandwich_tunnel_close) (struct SandwichTunnel \* tun)
_Close the tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_tunnel\_context\_free**](#function-sandwich_tunnel_context_free) (struct SandwichTunnelContext \* ctx)
_Free a Sandwich tunnel context._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) struct [**SandwichError**](structSandwichError.md) \* | [**sandwich\_tunnel\_context\_new**](#function-sandwich_tunnel_context_new) (const struct SandwichContext \* sw, struct [**SandwichTunnelContextConfigurationSerialized**](structSandwichTunnelContextConfigurationSerialized.md) configuration, struct SandwichTunnelContext \*\* ctx)
_Create a context from an encoded protobuf message._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) void | [**sandwich\_tunnel\_free**](#function-sandwich_tunnel_free) (struct SandwichTunnel \* tun)
_Free a Sandwich tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) struct [**SandwichError**](structSandwichError.md) \* | [**sandwich\_tunnel\_handshake**](#function-sandwich_tunnel_handshake) (struct SandwichTunnel \* tun, enum [**SandwichTunnelHandshakeState**](tunnel__types_8h.md#enum-sandwichtunnelhandshakestate) \* state)
_Perform the handshake._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) struct [**SandwichError**](structSandwichError.md) \* | [**sandwich\_tunnel\_new**](#function-sandwich_tunnel_new) (struct SandwichTunnelContext \* ctx, const struct [**SandwichIO**](structSandwichIO.md) \* io, struct [**SandwichTunnelConfigurationSerialized**](structSandwichTunnelConfigurationSerialized.md) configuration, struct SandwichTunnel \*\* tun)
_Create a tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichTunnelRecordError**](tunnel__types_8h.md#enum-sandwichtunnelrecorderror) | [**sandwich\_tunnel\_read**](#function-sandwich_tunnel_read) (struct SandwichTunnel \* tun, void \* dst, size\_t n, size\_t \* r)
_Read some bytes from the record plane of the tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichTunnelState**](tunnel__types_8h.md#enum-sandwichtunnelstate) | [**sandwich\_tunnel\_state**](#function-sandwich_tunnel_state) (const struct SandwichTunnel \* tun)
_Get the state of the tunnel._ |
+| [**SANDWICH\_API**](export_8h.md#define-sandwich_api) enum [**SandwichTunnelRecordError**](tunnel__types_8h.md#enum-sandwichtunnelrecorderror) | [**sandwich\_tunnel\_write**](#function-sandwich_tunnel_write) (struct SandwichTunnel \* tun, const void \* src, size\_t n, size\_t \* w)
_Write some bytes to the record plane of the tunnel._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Attributes Documentation
+
+
+
+
+### variable SandwichTunnelConfigurationVerifierEmpty
+
+```C++
+struct SandwichTunnelConfigurationSerialized SandwichTunnelConfigurationVerifierEmpty;
+```
+
+
+
+## Public Functions Documentation
+
+
+
+
+### function sandwich\_tunnel\_close
+
+_Close the tunnel._
+```C++
+SANDWICH_API void sandwich_tunnel_close (
+ struct SandwichTunnel * tun
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel to close.
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_context\_free
+
+_Free a Sandwich tunnel context._
+```C++
+SANDWICH_API void sandwich_tunnel_context_free (
+ struct SandwichTunnelContext * ctx
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `ctx` Context to free.
+
+NULL for `ctx` is allowed.
+
+
+
+
+
+
+### function sandwich\_tunnel\_context\_new
+
+_Create a context from an encoded protobuf message._
+```C++
+SANDWICH_API struct SandwichError * sandwich_tunnel_context_new (
+ const struct SandwichContext * sw,
+ struct SandwichTunnelContextConfigurationSerialized configuration,
+ struct SandwichTunnelContext ** ctx
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `sw` Top-level Sandwich context.
+* `configuration` Serialized configuration.
+* `ctx` The new Sandwich context object.
+
+
+
+**Returns:**
+
+NULL if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_free
+
+_Free a Sandwich tunnel._
+```C++
+SANDWICH_API void sandwich_tunnel_free (
+ struct SandwichTunnel * tun
+)
+```
+
+
+
+If the I/O interface is still owned by the tunnel, it will be freed too.
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel to free.
+
+NULL for `tun` is allowed.
+
+
+
+
+
+
+### function sandwich\_tunnel\_handshake
+
+_Perform the handshake._
+```C++
+SANDWICH_API struct SandwichError * sandwich_tunnel_handshake (
+ struct SandwichTunnel * tun,
+ enum SandwichTunnelHandshakeState * state
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel.
+* `state` The state of the tunnel
+
+
+
+**Returns:**
+
+Null if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_new
+
+_Create a tunnel._
+```C++
+SANDWICH_API struct SandwichError * sandwich_tunnel_new (
+ struct SandwichTunnelContext * ctx,
+ const struct SandwichIO * io,
+ struct SandwichTunnelConfigurationSerialized configuration,
+ struct SandwichTunnel ** tun
+)
+```
+
+
+
+A tunnel is created from an I/O interface. `SandwichIO` are used to create an I/O interface that forwards calls to the `read`, and `write` of `SandwichIO`.
+
+
+Since the implementation of `sandwich_tunnel_new` makes a copy of `SandwichIO`, the caller does not need to keep `io` in memory. In other words, Sandwich does not take the ownership of `io`.
+
+
+
+
+**Parameters:**
+
+
+* `ctx` Sandwich context used for setting up the tunnel.
+* `io` I/O interface to use to create the I/O interface.
+* `configuration` Additional configuration the connection is subject to. A null pointer is undefined behavior.
+* `tun` The new Sandwich tunnel object.
+
+
+
+**Returns:**
+
+NULL if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_read
+
+_Read some bytes from the record plane of the tunnel._
+```C++
+SANDWICH_API enum SandwichTunnelRecordError sandwich_tunnel_read (
+ struct SandwichTunnel * tun,
+ void * dst,
+ size_t n,
+ size_t * r
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel..
+* `dst` Destination buffer.
+* `n` Amount of bytes to read.
+* `r` Amount of bytes successfully read.
+
+NULL for `r` is allowed.
+
+
+
+
+**Returns:**
+
+An error code.
+
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_state
+
+_Get the state of the tunnel._
+```C++
+SANDWICH_API enum SandwichTunnelState sandwich_tunnel_state (
+ const struct SandwichTunnel * tun
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel.
+
+
+
+**Returns:**
+
+The state of the tunnel.
+
+
+
+
+
+
+
+
+
+### function sandwich\_tunnel\_write
+
+_Write some bytes to the record plane of the tunnel._
+```C++
+SANDWICH_API enum SandwichTunnelRecordError sandwich_tunnel_write (
+ struct SandwichTunnel * tun,
+ const void * src,
+ size_t n,
+ size_t * w
+)
+```
+
+
+
+
+
+**Parameters:**
+
+
+* `tun` Tunnel.
+* `src` Source buffer.
+* `n` Amount of bytes to read.
+* `w` Amount of bytes successfully written.
+
+NULL for `w` is allowed.
+
+
+
+
+**Returns:**
+
+An error code.
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/tunnel.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/tunnel_8h_source.md b/assets/.doxy/cAPI/cAPI/tunnel_8h_source.md
new file mode 100755
index 00000000..269176f7
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/tunnel_8h_source.md
@@ -0,0 +1,84 @@
+
+
+# File tunnel.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**tunnel.h**](tunnel_8h.md)
+
+[Go to the documentation of this file](tunnel_8h.md)
+
+```C++
+
+// Copyright (c) SandboxAQ. All rights reserved.
+// SPDX-License-Identifier: AGPL-3.0-only
+
+
+#pragma once
+
+#include
+
+#include "sandwich_c/export.h"
+#include "sandwich_c/io.h"
+#include "sandwich_c/tunnel_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct SandwichTunnelContext;
+
+struct SandwichTunnelContextConfigurationSerialized {
+ const void *src;
+
+ size_t n;
+};
+
+struct SandwichTunnelConfigurationSerialized {
+ const void *src;
+
+ size_t n;
+};
+
+extern struct SandwichTunnelConfigurationSerialized
+ SandwichTunnelConfigurationVerifierEmpty;
+
+struct SandwichTunnel;
+
+SANDWICH_API struct SandwichError *sandwich_tunnel_context_new(
+ const struct SandwichContext *sw,
+ struct SandwichTunnelContextConfigurationSerialized configuration,
+ struct SandwichTunnelContext **ctx);
+
+SANDWICH_API void
+sandwich_tunnel_context_free(struct SandwichTunnelContext *ctx);
+
+SANDWICH_API struct SandwichError *
+sandwich_tunnel_new(struct SandwichTunnelContext *ctx,
+ const struct SandwichIO *io,
+ struct SandwichTunnelConfigurationSerialized configuration,
+ struct SandwichTunnel **tun);
+
+SANDWICH_API struct SandwichError *
+sandwich_tunnel_handshake(struct SandwichTunnel *tun,
+ enum SandwichTunnelHandshakeState *state);
+
+SANDWICH_API enum SandwichTunnelRecordError
+sandwich_tunnel_read(struct SandwichTunnel *tun, void *dst, size_t n,
+ size_t *r);
+
+SANDWICH_API enum SandwichTunnelRecordError
+sandwich_tunnel_write(struct SandwichTunnel *tun, const void *src, size_t n,
+ size_t *w);
+
+SANDWICH_API void sandwich_tunnel_close(struct SandwichTunnel *tun);
+
+SANDWICH_API enum SandwichTunnelState
+sandwich_tunnel_state(const struct SandwichTunnel *tun);
+
+SANDWICH_API void sandwich_tunnel_free(struct SandwichTunnel *tun);
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/tunnel__types_8h.md b/assets/.doxy/cAPI/cAPI/tunnel__types_8h.md
new file mode 100755
index 00000000..78bb189a
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/tunnel__types_8h.md
@@ -0,0 +1,181 @@
+
+
+# File tunnel\_types.h
+
+
+
+[**FileList**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**tunnel\_types.h**](tunnel__types_8h.md)
+
+[Go to the source code of this file](tunnel__types_8h_source.md)
+
+_Sandwich tunnel types and states specification._
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types
+
+| Type | Name |
+| ---: | :--- |
+| enum | [**SandwichTunnelHandshakeState**](#enum-sandwichtunnelhandshakestate)
_Enum HandshakeState._ |
+| typedef enum [**SandwichTunnelHandshakeState**](tunnel__types_8h.md#enum-sandwichtunnelhandshakestate) | [**SandwichTunnelHandshakeState**](#typedef-sandwichtunnelhandshakestate)
|
+| enum | [**SandwichTunnelRecordError**](#enum-sandwichtunnelrecorderror)
_Enum RecordError._ |
+| typedef enum [**SandwichTunnelRecordError**](tunnel__types_8h.md#enum-sandwichtunnelrecorderror) | [**SandwichTunnelRecordError**](#typedef-sandwichtunnelrecorderror)
|
+| enum | [**SandwichTunnelState**](#enum-sandwichtunnelstate)
_Enum State._ |
+| typedef enum [**SandwichTunnelState**](tunnel__types_8h.md#enum-sandwichtunnelstate) | [**SandwichTunnelState**](#typedef-sandwichtunnelstate)
|
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Public Types Documentation
+
+
+
+
+### enum SandwichTunnelHandshakeState
+
+```C++
+enum SandwichTunnelHandshakeState {
+ SANDWICH_TUNNEL_HANDSHAKESTATE_IN_PROGRESS = 0,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_DONE = 1,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_READ = 2,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_WRITE = 3,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_ERROR = 4
+};
+```
+
+
+
+
+
+
+### typedef SandwichTunnelHandshakeState
+
+```C++
+typedef enum SandwichTunnelHandshakeState SandwichTunnelHandshakeState;
+```
+
+
+
+
+
+
+### enum SandwichTunnelRecordError
+
+```C++
+enum SandwichTunnelRecordError {
+ SANDWICH_TUNNEL_RECORDERROR_OK = 0,
+ SANDWICH_TUNNEL_RECORDERROR_WANT_READ = 1,
+ SANDWICH_TUNNEL_RECORDERROR_WANT_WRITE = 2,
+ SANDWICH_TUNNEL_RECORDERROR_BEING_SHUTDOWN = 3,
+ SANDWICH_TUNNEL_RECORDERROR_CLOSED = 4,
+ SANDWICH_TUNNEL_RECORDERROR_TOO_BIG = 5,
+ SANDWICH_TUNNEL_RECORDERROR_UNKNOWN = 6
+};
+```
+
+
+
+
+
+
+### typedef SandwichTunnelRecordError
+
+```C++
+typedef enum SandwichTunnelRecordError SandwichTunnelRecordError;
+```
+
+
+
+
+
+
+### enum SandwichTunnelState
+
+```C++
+enum SandwichTunnelState {
+ SANDWICH_TUNNEL_STATE_NOT_CONNECTED = 0,
+ SANDWICH_TUNNEL_STATE_CONNECTION_IN_PROGRESS = 1,
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_IN_PROGRESS = 2,
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_DONE = 3,
+ SANDWICH_TUNNEL_STATE_BEING_SHUTDOWN = 4,
+ SANDWICH_TUNNEL_STATE_DISCONNECTED = 5,
+ SANDWICH_TUNNEL_STATE_ERROR = 6
+};
+```
+
+
+
+
+
+
+### typedef SandwichTunnelState
+
+```C++
+typedef enum SandwichTunnelState SandwichTunnelState;
+```
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `docs/sandwich_c/tunnel_types.h`
+
diff --git a/assets/.doxy/cAPI/cAPI/tunnel__types_8h_source.md b/assets/.doxy/cAPI/cAPI/tunnel__types_8h_source.md
new file mode 100755
index 00000000..35e5a693
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/tunnel__types_8h_source.md
@@ -0,0 +1,69 @@
+
+
+# File tunnel\_types.h
+
+[**File List**](files.md) **>** [**docs**](dir_49e56c817e5e54854c35e136979f97ca.md) **>** [**sandwich\_c**](dir_f6ef5a90171f1138cc160f006fc74f9c.md) **>** [**tunnel\_types.h**](tunnel__types_8h.md)
+
+[Go to the documentation of this file](tunnel__types_8h.md)
+
+```C++
+
+// Copyright 2023 SandboxAQ
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+enum SandwichTunnelState {
+ SANDWICH_TUNNEL_STATE_NOT_CONNECTED = 0,
+ SANDWICH_TUNNEL_STATE_CONNECTION_IN_PROGRESS = 1,
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_IN_PROGRESS = 2,
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_DONE = 3,
+ SANDWICH_TUNNEL_STATE_BEING_SHUTDOWN = 4,
+ SANDWICH_TUNNEL_STATE_DISCONNECTED = 5,
+ SANDWICH_TUNNEL_STATE_ERROR = 6,
+};
+typedef enum SandwichTunnelState SandwichTunnelState;
+
+enum SandwichTunnelHandshakeState {
+ SANDWICH_TUNNEL_HANDSHAKESTATE_IN_PROGRESS = 0,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_DONE = 1,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_READ = 2,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_WRITE = 3,
+ SANDWICH_TUNNEL_HANDSHAKESTATE_ERROR = 4,
+};
+typedef enum SandwichTunnelHandshakeState SandwichTunnelHandshakeState;
+
+enum SandwichTunnelRecordError {
+ SANDWICH_TUNNEL_RECORDERROR_OK = 0,
+ SANDWICH_TUNNEL_RECORDERROR_WANT_READ = 1,
+ SANDWICH_TUNNEL_RECORDERROR_WANT_WRITE = 2,
+ SANDWICH_TUNNEL_RECORDERROR_BEING_SHUTDOWN = 3,
+ SANDWICH_TUNNEL_RECORDERROR_CLOSED = 4,
+ SANDWICH_TUNNEL_RECORDERROR_TOO_BIG = 5,
+ SANDWICH_TUNNEL_RECORDERROR_UNKNOWN = 6,
+};
+typedef enum SandwichTunnelRecordError SandwichTunnelRecordError;
+
+
+#ifdef __cplusplus
+} // end extern "C"
+#endif
+
+```
+
diff --git a/assets/.doxy/cAPI/cAPI/variables.md b/assets/.doxy/cAPI/cAPI/variables.md
new file mode 100755
index 00000000..2061e932
--- /dev/null
+++ b/assets/.doxy/cAPI/cAPI/variables.md
@@ -0,0 +1,38 @@
+
+# Variables
+
+
+
+## s
+
+* **SandwichALPNError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichAPIError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichASN1Error** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichCertificateError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichConfigurationError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichDataSourceError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichErrorKind** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichHandshakeError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichKEMError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichPrivateKeyError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichProtobufError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichSocketError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichSystemError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichTLSConfigurationError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichTunnelError** ([**error\_codes.h**](error__codes_8h.md))
+* **SandwichIOFlushFunctionPtr** ([**io.h**](io_8h.md))
+* **SandwichIOReadFunction** ([**io.h**](io_8h.md))
+* **SandwichIOReadFunctionPtr** ([**io.h**](io_8h.md))
+* **SandwichIOWriteFunction** ([**io.h**](io_8h.md))
+* **SandwichIOWriteFunctionPtr** ([**io.h**](io_8h.md))
+* **SandwichOwnedIOFreeFunction** ([**io.h**](io_8h.md))
+* **SandwichOwnedIOFreeFunctionPtr** ([**io.h**](io_8h.md))
+* **SandwichIOError** ([**ioerrors.h**](ioerrors_8h.md))
+* **SandwichTunnelConfigurationVerifierEmpty** ([**tunnel.h**](tunnel_8h.md))
+* **SandwichTunnelHandshakeState** ([**tunnel\_types.h**](tunnel__types_8h.md))
+* **SandwichTunnelRecordError** ([**tunnel\_types.h**](tunnel__types_8h.md))
+* **SandwichTunnelState** ([**tunnel\_types.h**](tunnel__types_8h.md))
+
+
+
+
diff --git a/assets/.doxy/cAPI/hashChanges.yaml b/assets/.doxy/cAPI/hashChanges.yaml
new file mode 100755
index 00000000..492fdb37
--- /dev/null
+++ b/assets/.doxy/cAPI/hashChanges.yaml
@@ -0,0 +1 @@
+88eeb4bda734bd53df54cd573245304914377861
\ No newline at end of file
diff --git a/assets/.doxy/cAPI/xml/Doxyfile.xml b/assets/.doxy/cAPI/xml/Doxyfile.xml
new file mode 100755
index 00000000..e80a9803
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/Doxyfile.xml
@@ -0,0 +1,342 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/combine.xslt b/assets/.doxy/cAPI/xml/combine.xslt
new file mode 100755
index 00000000..3bfa82c1
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/combine.xslt
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/compound.xsd b/assets/.doxy/cAPI/xml/compound.xsd
new file mode 100755
index 00000000..e3cf2e55
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/compound.xsd
@@ -0,0 +1,1635 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The mentioned file will be located in the directory as specified by XML_OUTPUT
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/dir_49e56c817e5e54854c35e136979f97ca.xml b/assets/.doxy/cAPI/xml/dir_49e56c817e5e54854c35e136979f97ca.xml
new file mode 100755
index 00000000..4748442c
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/dir_49e56c817e5e54854c35e136979f97ca.xml
@@ -0,0 +1,12 @@
+
+
+
+ docs
+ docs/sandwich_c
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/dir_f6ef5a90171f1138cc160f006fc74f9c.xml b/assets/.doxy/cAPI/xml/dir_f6ef5a90171f1138cc160f006fc74f9c.xml
new file mode 100755
index 00000000..88dd7ad8
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/dir_f6ef5a90171f1138cc160f006fc74f9c.xml
@@ -0,0 +1,21 @@
+
+
+
+ docs/sandwich_c
+ error.h
+ error_codes.h
+ export.h
+ io.h
+ ioerrors.h
+ lib.h
+ listener.h
+ sandwich.h
+ tunnel.h
+ tunnel_types.h
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/doxyfile.xsd b/assets/.doxy/cAPI/xml/doxyfile.xsd
new file mode 100755
index 00000000..fbfc2c13
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/doxyfile.xsd
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/error_8h.xml b/assets/.doxy/cAPI/xml/error_8h.xml
new file mode 100755
index 00000000..82486a74
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/error_8h.xml
@@ -0,0 +1,169 @@
+
+
+
+ error.h
+ sandwich_c/error_codes.h
+ sandwich_c/export.h
+ docs/sandwich_c/sandwich.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichError
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_error_free
+ (struct SandwichError *chain)
+ sandwich_error_free
+
+ struct [SandwichError] *
+ chain
+
+
+Free an error chain.
+
+
+
+
+chain
+
+
+Error chain.
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] char *
+ SANDWICH_API char * sandwich_error_stack_str_new
+ (const struct SandwichError *chain)
+ sandwich_error_stack_str_new
+
+ const struct [SandwichError] *
+ chain
+
+
+Create an error stack string from a [SandwichError] chain.
+
+
+
+
+chain
+
+
+Error chain.
+
+
+
+A NUL terminated string describing the [SandwichError] chain
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_error_stack_str_free
+ (const char *err_str)
+ sandwich_error_stack_str_free
+
+ const char *
+ err_str
+
+
+Free a an error string (generated from sandwich_error_stack_str_new)
+
+
+
+
+err_str
+
+
+Pointer to error string to free.
+
+
+
+NULL for err_str is allowed.
+
+
+
+
+
+
+
+Error handling for the Sandwich library.
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#include"[sandwich_c/error_codes.h]"
+#include"[sandwich_c/export.h]"
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+struct[SandwichError]{
+struct[SandwichError]*[details];
+
+constchar*[msg];
+
+[SandwichErrorKind][kind];
+
+int[code];
+};
+
+[SANDWICH_API]void[sandwich_error_free](struct[SandwichError]*chain);
+
+[SANDWICH_API]char*
+[sandwich_error_stack_str_new](conststruct[SandwichError]*chain);
+
+[SANDWICH_API]void[sandwich_error_stack_str_free](constchar*err_str);
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/error__codes_8h.xml b/assets/.doxy/cAPI/xml/error__codes_8h.xml
new file mode 100755
index 00000000..f2c5bc2a
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/error__codes_8h.xml
@@ -0,0 +1,1217 @@
+
+
+
+ error_codes.h
+ docs/sandwich_c/error.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichAPIError
+
+ SANDWICH_APIERROR_CONFIGURATION
+ = 0
+
+
+
+
+
+
+ SANDWICH_APIERROR_SOCKET
+ = 1
+
+
+
+
+
+
+ SANDWICH_APIERROR_TUNNEL
+ = 2
+
+
+
+
+
+
+Enum APIError.
+
+
+
+
+
+
+
+
+
+ SandwichConfigurationError
+
+ SANDWICH_CONFIGURATIONERROR_INVALID_IMPLEMENTATION
+ = 0
+
+
+
+
+
+
+ SANDWICH_CONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION
+ = 1
+
+
+
+
+
+
+ SANDWICH_CONFIGURATIONERROR_INVALID
+ = 2
+
+
+
+
+
+
+ SANDWICH_CONFIGURATIONERROR_INVALID_LISTENER
+ = 3
+
+
+
+
+
+
+Enum ConfigurationError.
+
+
+
+
+
+
+
+
+
+ SandwichProtobufError
+
+ SANDWICH_PROTOBUFERROR_EMPTY
+ = 0
+
+
+
+
+
+
+ SANDWICH_PROTOBUFERROR_TOO_BIG
+ = 1
+
+
+
+
+
+
+ SANDWICH_PROTOBUFERROR_PARSE_FAILED
+ = 2
+
+
+
+
+
+
+ SANDWICH_PROTOBUFERROR_NULLPTR
+ = 3
+
+
+
+
+
+
+ SANDWICH_PROTOBUFERROR_INVALID_ARGUMENT
+ = 4
+
+
+
+
+
+
+Enum ProtobufError.
+
+
+
+
+
+
+
+
+
+ SandwichTLSConfigurationError
+
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION
+ = 0
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID_CASE
+ = 1
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_EMPTY
+ = 2
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_PROTOCOL_VERSION
+ = 3
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_PRIVATE_KEY_INCONSISTENT_WITH_CERTIFICATE
+ = 4
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID
+ = 5
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CIPHERSUITE
+ = 6
+
+
+
+
+
+
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CONTROL_CHARACTERS
+ = 7
+
+
+
+
+
+
+Enum TLSConfigurationError.
+
+
+
+
+
+
+
+
+
+ SandwichCertificateError
+
+ SANDWICH_CERTIFICATEERROR_MALFORMED
+ = 0
+
+
+
+
+
+
+ SANDWICH_CERTIFICATEERROR_EXPIRED
+ = 1
+
+
+
+
+
+
+ SANDWICH_CERTIFICATEERROR_NOT_FOUND
+ = 2
+
+
+
+
+
+
+ SANDWICH_CERTIFICATEERROR_UNKNOWN
+ = 3
+
+
+
+
+
+
+ SANDWICH_CERTIFICATEERROR_UNSUPPORTED
+ = 4
+
+
+
+
+
+
+Enum CertificateError.
+
+
+
+
+
+
+
+
+
+ SandwichPrivateKeyError
+
+ SANDWICH_PRIVATEKEYERROR_MALFORMED
+ = 0
+
+
+
+
+
+
+ SANDWICH_PRIVATEKEYERROR_NOT_FOUND
+ = 1
+
+
+
+
+
+
+ SANDWICH_PRIVATEKEYERROR_UNKNOWN
+ = 2
+
+
+
+
+
+
+ SANDWICH_PRIVATEKEYERROR_UNSUPPORTED
+ = 3
+
+
+
+
+
+
+ SANDWICH_PRIVATEKEYERROR_NOT_SERVER
+ = 4
+
+
+
+
+
+
+Enum PrivateKeyError.
+
+
+
+
+
+
+
+
+
+ SandwichASN1Error
+
+ SANDWICH_ASN1ERROR_INVALID_FORMAT
+ = 0
+
+
+
+
+
+
+ SANDWICH_ASN1ERROR_MALFORMED
+ = 1
+
+
+
+
+
+
+Enum ASN1Error.
+
+
+
+
+
+
+
+
+
+ SandwichALPNError
+
+ SANDWICH_ALPNERROR_LENGTH_ERROR
+ = 0
+
+
+
+
+
+
+ SANDWICH_ALPNERROR_INVALID_STRING
+ = 1
+
+
+
+
+
+
+Enum ALPNError.
+
+
+
+
+
+
+
+
+
+ SandwichDataSourceError
+
+ SANDWICH_DATASOURCEERROR_EMPTY
+ = 0
+
+
+
+
+
+
+ SANDWICH_DATASOURCEERROR_INVALID_CASE
+ = 1
+
+
+
+
+
+
+ SANDWICH_DATASOURCEERROR_NOT_FOUND
+ = 2
+
+
+
+
+
+
+Enum DataSourceError.
+
+
+
+
+
+
+
+
+
+ SandwichKEMError
+
+ SANDWICH_KEMERROR_INVALID
+ = 0
+
+
+
+
+
+
+ SANDWICH_KEMERROR_TOO_MANY
+ = 1
+
+
+
+
+
+
+Enum KEMError.
+
+
+
+
+
+
+
+
+
+ SandwichSystemError
+
+ SANDWICH_SYSTEMERROR_MEMORY
+ = 0
+
+
+
+
+
+
+ SANDWICH_SYSTEMERROR_INTEGER_OVERFLOW
+ = 1
+
+
+
+
+
+
+ SANDWICH_SYSTEMERROR_BACKEND
+ = 2
+
+
+
+
+
+
+Enum SystemError.
+
+
+
+
+
+
+
+
+
+ SandwichSocketError
+
+ SANDWICH_SOCKETERROR_BAD_FD
+ = 0
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_CREATION_FAILED
+ = 1
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_BAD_NETADDR
+ = 2
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_NETADDR_UNKNOWN
+ = 3
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_FSTAT_FAILED
+ = 4
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_NOT_SOCK
+ = 5
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_GETSOCKNAME_FAILED
+ = 6
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_SETSOCKOPT_FAILED
+ = 7
+
+
+
+
+
+
+ SANDWICH_SOCKETERROR_INVALID_AI_FAMILY
+ = 8
+
+
+
+
+
+
+Enum SocketError.
+
+
+
+
+
+
+
+
+
+ SandwichHandshakeError
+
+ SANDWICH_HANDSHAKEERROR_INVALID_SERVER_NAME
+ = 0
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_VERIFICATION_FAILED
+ = 1
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_EXPIRED
+ = 2
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_REVOKED
+ = 3
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_INVALID_CERTIFICATE
+ = 4
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_SIGNATURE_VERIFICATION_FAILED
+ = 5
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_UNKNOWN_ERROR
+ = 6
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_DEPTH_EXCEEDED
+ = 7
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_UNSUPPORTED_PROTOCOL
+ = 8
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_NO_SHARED_CIPHER
+ = 9
+
+
+
+
+
+
+ SANDWICH_HANDSHAKEERROR_NO_SUITABLE_KEY_SHARE
+ = 10
+
+
+
+
+
+
+Enum HandshakeError.
+
+
+
+
+
+
+
+
+
+ SandwichTunnelError
+
+ SANDWICH_TUNNELERROR_INVALID
+ = 0
+
+
+
+
+
+
+ SANDWICH_TUNNELERROR_VERIFIER
+ = 1
+
+
+
+
+
+
+ SANDWICH_TUNNELERROR_UNKNOWN
+ = 2
+
+
+
+
+
+
+Enum TunnelError.
+
+
+
+
+
+
+
+
+
+ SandwichErrorKind
+
+ SANDWICH_ERRORKIND_API
+ = 0
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_CONFIGURATION
+ = 1
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_TLS_CONFIGURATION
+ = 2
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_CERTIFICATE
+ = 3
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_SYSTEM
+ = 4
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_SOCKET
+ = 5
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_PROTOBUF
+ = 6
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_PRIVATE_KEY
+ = 7
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_ASN1
+ = 8
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_DATA_SOURCE
+ = 9
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_KEM
+ = 10
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_HANDSHAKE
+ = 11
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_TUNNEL
+ = 12
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_ALPN
+ = 13
+
+
+
+
+
+
+ SANDWICH_ERRORKIND_IO
+ = 14
+
+
+
+
+
+
+Enum ErrorKind.
+
+
+
+
+
+
+
+
+
+
+ enum [SandwichAPIError]
+ typedef enum SandwichAPIError SandwichAPIError
+
+ SandwichAPIError
+
+
+
+
+
+
+
+
+
+ enum [SandwichConfigurationError]
+ typedef enum SandwichConfigurationError SandwichConfigurationError
+
+ SandwichConfigurationError
+
+
+
+
+
+
+
+
+
+ enum [SandwichProtobufError]
+ typedef enum SandwichProtobufError SandwichProtobufError
+
+ SandwichProtobufError
+
+
+
+
+
+
+
+
+
+ enum [SandwichTLSConfigurationError]
+ typedef enum SandwichTLSConfigurationError SandwichTLSConfigurationError
+
+ SandwichTLSConfigurationError
+
+
+
+
+
+
+
+
+
+ enum [SandwichCertificateError]
+ typedef enum SandwichCertificateError SandwichCertificateError
+
+ SandwichCertificateError
+
+
+
+
+
+
+
+
+
+ enum [SandwichPrivateKeyError]
+ typedef enum SandwichPrivateKeyError SandwichPrivateKeyError
+
+ SandwichPrivateKeyError
+
+
+
+
+
+
+
+
+
+ enum [SandwichASN1Error]
+ typedef enum SandwichASN1Error SandwichASN1Error
+
+ SandwichASN1Error
+
+
+
+
+
+
+
+
+
+ enum [SandwichALPNError]
+ typedef enum SandwichALPNError SandwichALPNError
+
+ SandwichALPNError
+
+
+
+
+
+
+
+
+
+ enum [SandwichDataSourceError]
+ typedef enum SandwichDataSourceError SandwichDataSourceError
+
+ SandwichDataSourceError
+
+
+
+
+
+
+
+
+
+ enum [SandwichKEMError]
+ typedef enum SandwichKEMError SandwichKEMError
+
+ SandwichKEMError
+
+
+
+
+
+
+
+
+
+ enum [SandwichSystemError]
+ typedef enum SandwichSystemError SandwichSystemError
+
+ SandwichSystemError
+
+
+
+
+
+
+
+
+
+ enum [SandwichSocketError]
+ typedef enum SandwichSocketError SandwichSocketError
+
+ SandwichSocketError
+
+
+
+
+
+
+
+
+
+ enum [SandwichHandshakeError]
+ typedef enum SandwichHandshakeError SandwichHandshakeError
+
+ SandwichHandshakeError
+
+
+
+
+
+
+
+
+
+ enum [SandwichTunnelError]
+ typedef enum SandwichTunnelError SandwichTunnelError
+
+ SandwichTunnelError
+
+
+
+
+
+
+
+
+
+ enum [SandwichErrorKind]
+ typedef enum SandwichErrorKind SandwichErrorKind
+
+ SandwichErrorKind
+
+
+
+
+
+
+
+
+
+
+Sandwich errors specification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+
+enum[SandwichAPIError]{
+[SANDWICH_APIERROR_CONFIGURATION]=0,
+[SANDWICH_APIERROR_SOCKET]=1,
+[SANDWICH_APIERROR_TUNNEL]=2,
+};
+typedefenum[SandwichAPIError][SandwichAPIError];
+
+enum[SandwichConfigurationError]{
+[SANDWICH_CONFIGURATIONERROR_INVALID_IMPLEMENTATION]=0,
+[SANDWICH_CONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION]=1,
+[SANDWICH_CONFIGURATIONERROR_INVALID]=2,
+[SANDWICH_CONFIGURATIONERROR_INVALID_LISTENER]=3,
+};
+typedefenum[SandwichConfigurationError][SandwichConfigurationError];
+
+enum[SandwichProtobufError]{
+[SANDWICH_PROTOBUFERROR_EMPTY]=0,
+[SANDWICH_PROTOBUFERROR_TOO_BIG]=1,
+[SANDWICH_PROTOBUFERROR_PARSE_FAILED]=2,
+[SANDWICH_PROTOBUFERROR_NULLPTR]=3,
+[SANDWICH_PROTOBUFERROR_INVALID_ARGUMENT]=4,
+};
+typedefenum[SandwichProtobufError][SandwichProtobufError];
+
+enum[SandwichTLSConfigurationError]{
+[SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION]=0,
+[SANDWICH_TLSCONFIGURATIONERROR_INVALID_CASE]=1,
+[SANDWICH_TLSCONFIGURATIONERROR_EMPTY]=2,
+[SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_PROTOCOL_VERSION]=3,
+[SANDWICH_TLSCONFIGURATIONERROR_PRIVATE_KEY_INCONSISTENT_WITH_CERTIFICATE]=4,
+[SANDWICH_TLSCONFIGURATIONERROR_INVALID]=5,
+[SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CIPHERSUITE]=6,
+[SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CONTROL_CHARACTERS]=7,
+};
+typedefenum[SandwichTLSConfigurationError][SandwichTLSConfigurationError];
+
+enum[SandwichCertificateError]{
+[SANDWICH_CERTIFICATEERROR_MALFORMED]=0,
+[SANDWICH_CERTIFICATEERROR_EXPIRED]=1,
+[SANDWICH_CERTIFICATEERROR_NOT_FOUND]=2,
+[SANDWICH_CERTIFICATEERROR_UNKNOWN]=3,
+[SANDWICH_CERTIFICATEERROR_UNSUPPORTED]=4,
+};
+typedefenum[SandwichCertificateError][SandwichCertificateError];
+
+enum[SandwichPrivateKeyError]{
+[SANDWICH_PRIVATEKEYERROR_MALFORMED]=0,
+[SANDWICH_PRIVATEKEYERROR_NOT_FOUND]=1,
+[SANDWICH_PRIVATEKEYERROR_UNKNOWN]=2,
+[SANDWICH_PRIVATEKEYERROR_UNSUPPORTED]=3,
+[SANDWICH_PRIVATEKEYERROR_NOT_SERVER]=4,
+};
+typedefenum[SandwichPrivateKeyError][SandwichPrivateKeyError];
+
+enum[SandwichASN1Error]{
+[SANDWICH_ASN1ERROR_INVALID_FORMAT]=0,
+[SANDWICH_ASN1ERROR_MALFORMED]=1,
+};
+typedefenum[SandwichASN1Error][SandwichASN1Error];
+
+enum[SandwichALPNError]{
+[SANDWICH_ALPNERROR_LENGTH_ERROR]=0,
+[SANDWICH_ALPNERROR_INVALID_STRING]=1,
+};
+typedefenum[SandwichALPNError][SandwichALPNError];
+
+enum[SandwichDataSourceError]{
+[SANDWICH_DATASOURCEERROR_EMPTY]=0,
+[SANDWICH_DATASOURCEERROR_INVALID_CASE]=1,
+[SANDWICH_DATASOURCEERROR_NOT_FOUND]=2,
+};
+typedefenum[SandwichDataSourceError][SandwichDataSourceError];
+
+enum[SandwichKEMError]{
+[SANDWICH_KEMERROR_INVALID]=0,
+[SANDWICH_KEMERROR_TOO_MANY]=1,
+};
+typedefenum[SandwichKEMError][SandwichKEMError];
+
+enum[SandwichSystemError]{
+[SANDWICH_SYSTEMERROR_MEMORY]=0,
+[SANDWICH_SYSTEMERROR_INTEGER_OVERFLOW]=1,
+[SANDWICH_SYSTEMERROR_BACKEND]=2,
+};
+typedefenum[SandwichSystemError][SandwichSystemError];
+
+enum[SandwichSocketError]{
+[SANDWICH_SOCKETERROR_BAD_FD]=0,
+[SANDWICH_SOCKETERROR_CREATION_FAILED]=1,
+[SANDWICH_SOCKETERROR_BAD_NETADDR]=2,
+[SANDWICH_SOCKETERROR_NETADDR_UNKNOWN]=3,
+[SANDWICH_SOCKETERROR_FSTAT_FAILED]=4,
+[SANDWICH_SOCKETERROR_NOT_SOCK]=5,
+[SANDWICH_SOCKETERROR_GETSOCKNAME_FAILED]=6,
+[SANDWICH_SOCKETERROR_SETSOCKOPT_FAILED]=7,
+[SANDWICH_SOCKETERROR_INVALID_AI_FAMILY]=8,
+};
+typedefenum[SandwichSocketError][SandwichSocketError];
+
+enum[SandwichHandshakeError]{
+[SANDWICH_HANDSHAKEERROR_INVALID_SERVER_NAME]=0,
+[SANDWICH_HANDSHAKEERROR_CERTIFICATE_VERIFICATION_FAILED]=1,
+[SANDWICH_HANDSHAKEERROR_CERTIFICATE_EXPIRED]=2,
+[SANDWICH_HANDSHAKEERROR_CERTIFICATE_REVOKED]=3,
+[SANDWICH_HANDSHAKEERROR_INVALID_CERTIFICATE]=4,
+[SANDWICH_HANDSHAKEERROR_CERTIFICATE_SIGNATURE_VERIFICATION_FAILED]=5,
+[SANDWICH_HANDSHAKEERROR_UNKNOWN_ERROR]=6,
+[SANDWICH_HANDSHAKEERROR_DEPTH_EXCEEDED]=7,
+[SANDWICH_HANDSHAKEERROR_UNSUPPORTED_PROTOCOL]=8,
+[SANDWICH_HANDSHAKEERROR_NO_SHARED_CIPHER]=9,
+[SANDWICH_HANDSHAKEERROR_NO_SUITABLE_KEY_SHARE]=10,
+};
+typedefenum[SandwichHandshakeError][SandwichHandshakeError];
+
+enum[SandwichTunnelError]{
+[SANDWICH_TUNNELERROR_INVALID]=0,
+[SANDWICH_TUNNELERROR_VERIFIER]=1,
+[SANDWICH_TUNNELERROR_UNKNOWN]=2,
+};
+typedefenum[SandwichTunnelError][SandwichTunnelError];
+
+enum[SandwichErrorKind]{
+[SANDWICH_ERRORKIND_API]=0,
+[SANDWICH_ERRORKIND_CONFIGURATION]=1,
+[SANDWICH_ERRORKIND_TLS_CONFIGURATION]=2,
+[SANDWICH_ERRORKIND_CERTIFICATE]=3,
+[SANDWICH_ERRORKIND_SYSTEM]=4,
+[SANDWICH_ERRORKIND_SOCKET]=5,
+[SANDWICH_ERRORKIND_PROTOBUF]=6,
+[SANDWICH_ERRORKIND_PRIVATE_KEY]=7,
+[SANDWICH_ERRORKIND_ASN1]=8,
+[SANDWICH_ERRORKIND_DATA_SOURCE]=9,
+[SANDWICH_ERRORKIND_KEM]=10,
+[SANDWICH_ERRORKIND_HANDSHAKE]=11,
+[SANDWICH_ERRORKIND_TUNNEL]=12,
+[SANDWICH_ERRORKIND_ALPN]=13,
+[SANDWICH_ERRORKIND_IO]=14,
+};
+typedefenum[SandwichErrorKind][SandwichErrorKind];
+
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/export_8h.xml b/assets/.doxy/cAPI/xml/export_8h.xml
new file mode 100755
index 00000000..a95703c2
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/export_8h.xml
@@ -0,0 +1,94 @@
+
+
+
+ export.h
+ docs/sandwich_c/error.h
+ docs/sandwich_c/io.h
+ docs/sandwich_c/lib.h
+ docs/sandwich_c/listener.h
+ docs/sandwich_c/tunnel.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SANDWICH_API
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#if(defined(__clang__)||(_GNUC__>=4))
+#defineSANDWICH_API__attribute__((visibility("default")))
+#else
+#defineSANDWICH_API
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/index.xml b/assets/.doxy/cAPI/xml/index.xml
new file mode 100755
index 00000000..7a752e59
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/index.xml
@@ -0,0 +1,229 @@
+
+
+ SandwichError
+ details
+ msg
+ kind
+ code
+
+ SandwichIO
+ read
+ write
+ flush
+ uarg
+
+ SandwichIOOwned
+ io
+ freeptr
+
+ SandwichTunnelConfigurationSerialized
+ src
+ n
+
+ SandwichTunnelContextConfigurationSerialized
+ src
+ n
+
+ error.h
+ sandwich_error_free
+ sandwich_error_stack_str_new
+ sandwich_error_stack_str_free
+
+ error_codes.h
+ SandwichAPIError
+ SANDWICH_APIERROR_CONFIGURATION
+ SANDWICH_APIERROR_SOCKET
+ SANDWICH_APIERROR_TUNNEL
+ SandwichConfigurationError
+ SANDWICH_CONFIGURATIONERROR_INVALID_IMPLEMENTATION
+ SANDWICH_CONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION
+ SANDWICH_CONFIGURATIONERROR_INVALID
+ SANDWICH_CONFIGURATIONERROR_INVALID_LISTENER
+ SandwichProtobufError
+ SANDWICH_PROTOBUFERROR_EMPTY
+ SANDWICH_PROTOBUFERROR_TOO_BIG
+ SANDWICH_PROTOBUFERROR_PARSE_FAILED
+ SANDWICH_PROTOBUFERROR_NULLPTR
+ SANDWICH_PROTOBUFERROR_INVALID_ARGUMENT
+ SandwichTLSConfigurationError
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_IMPLEMENTATION
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID_CASE
+ SANDWICH_TLSCONFIGURATIONERROR_EMPTY
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_PROTOCOL_VERSION
+ SANDWICH_TLSCONFIGURATIONERROR_PRIVATE_KEY_INCONSISTENT_WITH_CERTIFICATE
+ SANDWICH_TLSCONFIGURATIONERROR_INVALID
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CIPHERSUITE
+ SANDWICH_TLSCONFIGURATIONERROR_UNSUPPORTED_CONTROL_CHARACTERS
+ SandwichCertificateError
+ SANDWICH_CERTIFICATEERROR_MALFORMED
+ SANDWICH_CERTIFICATEERROR_EXPIRED
+ SANDWICH_CERTIFICATEERROR_NOT_FOUND
+ SANDWICH_CERTIFICATEERROR_UNKNOWN
+ SANDWICH_CERTIFICATEERROR_UNSUPPORTED
+ SandwichPrivateKeyError
+ SANDWICH_PRIVATEKEYERROR_MALFORMED
+ SANDWICH_PRIVATEKEYERROR_NOT_FOUND
+ SANDWICH_PRIVATEKEYERROR_UNKNOWN
+ SANDWICH_PRIVATEKEYERROR_UNSUPPORTED
+ SANDWICH_PRIVATEKEYERROR_NOT_SERVER
+ SandwichASN1Error
+ SANDWICH_ASN1ERROR_INVALID_FORMAT
+ SANDWICH_ASN1ERROR_MALFORMED
+ SandwichALPNError
+ SANDWICH_ALPNERROR_LENGTH_ERROR
+ SANDWICH_ALPNERROR_INVALID_STRING
+ SandwichDataSourceError
+ SANDWICH_DATASOURCEERROR_EMPTY
+ SANDWICH_DATASOURCEERROR_INVALID_CASE
+ SANDWICH_DATASOURCEERROR_NOT_FOUND
+ SandwichKEMError
+ SANDWICH_KEMERROR_INVALID
+ SANDWICH_KEMERROR_TOO_MANY
+ SandwichSystemError
+ SANDWICH_SYSTEMERROR_MEMORY
+ SANDWICH_SYSTEMERROR_INTEGER_OVERFLOW
+ SANDWICH_SYSTEMERROR_BACKEND
+ SandwichSocketError
+ SANDWICH_SOCKETERROR_BAD_FD
+ SANDWICH_SOCKETERROR_CREATION_FAILED
+ SANDWICH_SOCKETERROR_BAD_NETADDR
+ SANDWICH_SOCKETERROR_NETADDR_UNKNOWN
+ SANDWICH_SOCKETERROR_FSTAT_FAILED
+ SANDWICH_SOCKETERROR_NOT_SOCK
+ SANDWICH_SOCKETERROR_GETSOCKNAME_FAILED
+ SANDWICH_SOCKETERROR_SETSOCKOPT_FAILED
+ SANDWICH_SOCKETERROR_INVALID_AI_FAMILY
+ SandwichHandshakeError
+ SANDWICH_HANDSHAKEERROR_INVALID_SERVER_NAME
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_VERIFICATION_FAILED
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_EXPIRED
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_REVOKED
+ SANDWICH_HANDSHAKEERROR_INVALID_CERTIFICATE
+ SANDWICH_HANDSHAKEERROR_CERTIFICATE_SIGNATURE_VERIFICATION_FAILED
+ SANDWICH_HANDSHAKEERROR_UNKNOWN_ERROR
+ SANDWICH_HANDSHAKEERROR_DEPTH_EXCEEDED
+ SANDWICH_HANDSHAKEERROR_UNSUPPORTED_PROTOCOL
+ SANDWICH_HANDSHAKEERROR_NO_SHARED_CIPHER
+ SANDWICH_HANDSHAKEERROR_NO_SUITABLE_KEY_SHARE
+ SandwichTunnelError
+ SANDWICH_TUNNELERROR_INVALID
+ SANDWICH_TUNNELERROR_VERIFIER
+ SANDWICH_TUNNELERROR_UNKNOWN
+ SandwichErrorKind
+ SANDWICH_ERRORKIND_API
+ SANDWICH_ERRORKIND_CONFIGURATION
+ SANDWICH_ERRORKIND_TLS_CONFIGURATION
+ SANDWICH_ERRORKIND_CERTIFICATE
+ SANDWICH_ERRORKIND_SYSTEM
+ SANDWICH_ERRORKIND_SOCKET
+ SANDWICH_ERRORKIND_PROTOBUF
+ SANDWICH_ERRORKIND_PRIVATE_KEY
+ SANDWICH_ERRORKIND_ASN1
+ SANDWICH_ERRORKIND_DATA_SOURCE
+ SANDWICH_ERRORKIND_KEM
+ SANDWICH_ERRORKIND_HANDSHAKE
+ SANDWICH_ERRORKIND_TUNNEL
+ SANDWICH_ERRORKIND_ALPN
+ SANDWICH_ERRORKIND_IO
+ SandwichAPIError
+ SandwichConfigurationError
+ SandwichProtobufError
+ SandwichTLSConfigurationError
+ SandwichCertificateError
+ SandwichPrivateKeyError
+ SandwichASN1Error
+ SandwichALPNError
+ SandwichDataSourceError
+ SandwichKEMError
+ SandwichSystemError
+ SandwichSocketError
+ SandwichHandshakeError
+ SandwichTunnelError
+ SandwichErrorKind
+
+ export.h
+ SANDWICH_API
+
+ io.h
+ SandwichIOReadFunction
+ SandwichIOReadFunctionPtr
+ SandwichIOWriteFunction
+ SandwichIOWriteFunctionPtr
+ SandwichIOFlushFunctionPtr
+ SandwichOwnedIOFreeFunction
+ SandwichOwnedIOFreeFunctionPtr
+ SandwichIOFlushFunction
+ sandwich_io_client_tcp_new
+ sandwich_io_socket_wrap_new
+ sandwich_io_owned_free
+
+ ioerrors.h
+ SandwichIOError
+ SANDWICH_IOERROR_OK
+ SANDWICH_IOERROR_IN_PROGRESS
+ SANDWICH_IOERROR_WOULD_BLOCK
+ SANDWICH_IOERROR_REFUSED
+ SANDWICH_IOERROR_CLOSED
+ SANDWICH_IOERROR_INVALID
+ SANDWICH_IOERROR_UNKNOWN
+ SANDWICH_IOERROR_SYSTEM_ERROR
+ SANDWICH_IOERROR_ADDRESS_IN_USE
+ SandwichIOError
+
+ lib.h
+ sandwich_lib_context_new
+ sandwich_lib_context_free
+
+ listener.h
+ sandwich_listener_new
+ sandwich_listener_listen
+ sandwich_listener_accept
+ sandwich_listener_close
+ sandwich_listener_free
+
+ sandwich.h
+
+ tunnel.h
+ SandwichTunnelConfigurationVerifierEmpty
+ sandwich_tunnel_context_new
+ sandwich_tunnel_context_free
+ sandwich_tunnel_new
+ sandwich_tunnel_handshake
+ sandwich_tunnel_read
+ sandwich_tunnel_write
+ sandwich_tunnel_close
+ sandwich_tunnel_state
+ sandwich_tunnel_free
+
+ tunnel_types.h
+ SandwichTunnelState
+ SANDWICH_TUNNEL_STATE_NOT_CONNECTED
+ SANDWICH_TUNNEL_STATE_CONNECTION_IN_PROGRESS
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_IN_PROGRESS
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_DONE
+ SANDWICH_TUNNEL_STATE_BEING_SHUTDOWN
+ SANDWICH_TUNNEL_STATE_DISCONNECTED
+ SANDWICH_TUNNEL_STATE_ERROR
+ SandwichTunnelHandshakeState
+ SANDWICH_TUNNEL_HANDSHAKESTATE_IN_PROGRESS
+ SANDWICH_TUNNEL_HANDSHAKESTATE_DONE
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_READ
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_WRITE
+ SANDWICH_TUNNEL_HANDSHAKESTATE_ERROR
+ SandwichTunnelRecordError
+ SANDWICH_TUNNEL_RECORDERROR_OK
+ SANDWICH_TUNNEL_RECORDERROR_WANT_READ
+ SANDWICH_TUNNEL_RECORDERROR_WANT_WRITE
+ SANDWICH_TUNNEL_RECORDERROR_BEING_SHUTDOWN
+ SANDWICH_TUNNEL_RECORDERROR_CLOSED
+ SANDWICH_TUNNEL_RECORDERROR_TOO_BIG
+ SANDWICH_TUNNEL_RECORDERROR_UNKNOWN
+ SandwichTunnelState
+ SandwichTunnelHandshakeState
+ SandwichTunnelRecordError
+
+ docs
+
+ docs/sandwich_c
+
+
diff --git a/assets/.doxy/cAPI/xml/index.xsd b/assets/.doxy/cAPI/xml/index.xsd
new file mode 100755
index 00000000..6c847cc3
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/index.xsd
@@ -0,0 +1,72 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/io_8h.xml b/assets/.doxy/cAPI/xml/io_8h.xml
new file mode 100755
index 00000000..c2c370fa
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/io_8h.xml
@@ -0,0 +1,485 @@
+
+
+
+ io.h
+ sys/types.h
+ sandwich_c/export.h
+ sandwich_c/ioerrors.h
+ sandwich_c/tunnel_types.h
+ docs/sandwich_c/listener.h
+ docs/sandwich_c/sandwich.h
+ docs/sandwich_c/tunnel.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichIO
+ SandwichIOOwned
+
+
+ size_t()
+ typedef size_t() SandwichIOReadFunction(void *uarg, void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err)
+ (void *uarg, void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err)
+ SandwichIOReadFunction
+
+Read function for the I/O interface.
+
+
+
+
+uarg
+
+
+User opaque argument.
+
+
+
+
+buf
+
+
+Destination buffer.
+
+
+
+
+count
+
+
+Amount of bytes to read.
+
+
+
+
+tunnel_state
+
+
+Current state of the tunnel.
+
+
+
+
+err
+
+
+Error, if any.
+
+
+
+The amount of bytes successfully read, or 0.
+
+
+
+
+
+
+
+
+ [SandwichIOReadFunction] *
+ typedef SandwichIOReadFunction* SandwichIOReadFunctionPtr
+
+ SandwichIOReadFunctionPtr
+
+
+
+
+
+
+
+
+
+ size_t()
+ typedef size_t() SandwichIOWriteFunction(void *uarg, const void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err)
+ (void *uarg, const void *buf, size_t count, enum SandwichTunnelState tunnel_state, enum SandwichIOError *err)
+ SandwichIOWriteFunction
+
+Write function for the I/O interface.
+
+
+
+
+uarg
+
+
+User opaque argument.
+
+
+
+
+buf
+
+
+Source buffer.
+
+
+
+
+count
+
+
+Amount of bytes to write.
+
+
+
+
+tunnel_state
+
+
+Current state of the tunnel.
+
+
+
+
+err
+
+
+Error, if any.
+
+
+
+The amount of bytes successfully written, or 0.
+
+
+
+
+
+
+
+
+ [SandwichIOWriteFunction] *
+ typedef SandwichIOWriteFunction* SandwichIOWriteFunctionPtr
+
+ SandwichIOWriteFunctionPtr
+
+
+
+
+
+
+
+
+
+ [SandwichIOFlushFunction] *
+ typedef SandwichIOFlushFunction* SandwichIOFlushFunctionPtr
+
+ SandwichIOFlushFunctionPtr
+
+
+
+
+
+
+
+
+
+ void()
+ typedef void() SandwichOwnedIOFreeFunction(struct SandwichIO *io)
+ (struct SandwichIO *io)
+ SandwichOwnedIOFreeFunction
+
+A destructor function for owned I/O interface.
+
+
+
+
+
+
+
+
+ [SandwichOwnedIOFreeFunction] *
+ typedef SandwichOwnedIOFreeFunction* SandwichOwnedIOFreeFunctionPtr
+
+ SandwichOwnedIOFreeFunctionPtr
+
+
+
+
+
+
+
+
+
+
+
+ enum [SandwichIOError]()
+ enum SandwichIOError() SandwichIOFlushFunction
+ (void *uarg)
+ SandwichIOFlushFunction
+
+ void *
+ uarg
+
+
+Flush function for the I/O interface.
+
+
+
+
+uarg
+
+
+User opaque argument.
+
+
+
+IOERROR_OK if success, else an IO error.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichIOError]
+ SANDWICH_API enum SandwichIOError sandwich_io_client_tcp_new
+ (const char *hostname, uint16_t port, bool async, struct SandwichIOOwned **ownedIO)
+ sandwich_io_client_tcp_new
+
+ const char *
+ hostname
+
+
+ uint16_t
+ port
+
+
+ bool
+ async
+
+
+ struct [SandwichIOOwned] **
+ ownedIO
+
+
+Creates a TCP based IO object to be used for a client tunnel.
+
+
+
+
+hostname
+
+
+the hostname of the target server.
+
+
+
+
+port
+
+
+the port number of the target server.
+
+
+
+
+async
+
+
+indicates whether sockets should be non-blocking or not.
+
+
+
+
+ownedIO
+
+
+the created TCP based sandwich owned IO object.
+
+
+
+IOERROR_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichIOError]
+ SANDWICH_API enum SandwichIOError sandwich_io_socket_wrap_new
+ (int fd, struct SandwichIOOwned **ownedIO)
+ sandwich_io_socket_wrap_new
+
+ int
+ fd
+
+
+ struct [SandwichIOOwned] **
+ ownedIO
+
+
+Creates an IO object that wraps a UNIX socket.
+
+
+
+
+fd
+
+
+the file descriptor of the unix socket.
+
+
+
+
+ownedIO
+
+
+the created UNIX socket sandwich owned IO object. The caller is responsible for freeing that object with [sandwich_io_owned_free].
+
+
+
+IOERROR_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_io_owned_free
+ (struct SandwichIOOwned *ownedIO)
+ sandwich_io_owned_free
+
+ struct [SandwichIOOwned] *
+ ownedIO
+
+
+Frees a [SandwichIOOwned] object created by one of the sandwich_io_*_new() functions.
+
+
+
+
+
+
+
+
+
+I/O abstraction for Sandwich.
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#include<sys/types.h>
+
+#include"[sandwich_c/export.h]"
+#include"[sandwich_c/ioerrors.h]"
+#include"[sandwich_c/tunnel_types.h]"
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+typedefsize_t([SandwichIOReadFunction])(void*uarg,void*buf,size_tcount,
+enum[SandwichTunnelState]tunnel_state,
+enum[SandwichIOError]*err);
+typedef[SandwichIOReadFunction]*[SandwichIOReadFunctionPtr];
+
+typedefsize_t([SandwichIOWriteFunction])(void*uarg,constvoid*buf,
+size_tcount,
+enum[SandwichTunnelState]tunnel_state,
+enum[SandwichIOError]*err);
+typedef[SandwichIOWriteFunction]*[SandwichIOWriteFunctionPtr];
+
+typedefenum[SandwichIOError]([SandwichIOFlushFunction])(void*uarg);
+typedef[SandwichIOFlushFunction]*[SandwichIOFlushFunctionPtr];
+
+struct[SandwichIO]{
+[SandwichIOReadFunctionPtr][read];
+
+[SandwichIOWriteFunctionPtr][write];
+
+[SandwichIOFlushFunctionPtr][flush];
+
+void*[uarg];
+};
+
+typedefvoid([SandwichOwnedIOFreeFunction])(struct[SandwichIO]*io);
+typedef[SandwichOwnedIOFreeFunction]*[SandwichOwnedIOFreeFunctionPtr];
+
+struct[SandwichIOOwned]{
+
+struct[SandwichIO]*[io];
+
+
+[SandwichOwnedIOFreeFunctionPtr][freeptr];
+};
+
+[SANDWICH_API]enum[SandwichIOError]
+[sandwich_io_client_tcp_new](constchar*hostname,uint16_tport,boolasync,
+struct[SandwichIOOwned]**ownedIO);
+
+[SANDWICH_API]enum[SandwichIOError]
+[sandwich_io_socket_wrap_new](intfd,struct[SandwichIOOwned]**ownedIO);
+
+[SANDWICH_API]void[sandwich_io_owned_free](struct[SandwichIOOwned]*ownedIO);
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/ioerrors_8h.xml b/assets/.doxy/cAPI/xml/ioerrors_8h.xml
new file mode 100755
index 00000000..b444994e
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/ioerrors_8h.xml
@@ -0,0 +1,188 @@
+
+
+
+ ioerrors.h
+ docs/sandwich_c/io.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichIOError
+
+ SANDWICH_IOERROR_OK
+ = 0
+
+
+
+
+
+
+ SANDWICH_IOERROR_IN_PROGRESS
+ = 1
+
+
+
+
+
+
+ SANDWICH_IOERROR_WOULD_BLOCK
+ = 2
+
+
+
+
+
+
+ SANDWICH_IOERROR_REFUSED
+ = 3
+
+
+
+
+
+
+ SANDWICH_IOERROR_CLOSED
+ = 4
+
+
+
+
+
+
+ SANDWICH_IOERROR_INVALID
+ = 5
+
+
+
+
+
+
+ SANDWICH_IOERROR_UNKNOWN
+ = 6
+
+
+
+
+
+
+ SANDWICH_IOERROR_SYSTEM_ERROR
+ = 7
+
+
+
+
+
+
+ SANDWICH_IOERROR_ADDRESS_IN_USE
+ = 8
+
+
+
+
+
+
+Enum IOError.
+
+
+
+
+
+
+
+
+
+
+ enum [SandwichIOError]
+ typedef enum SandwichIOError SandwichIOError
+
+ SandwichIOError
+
+
+
+
+
+
+
+
+
+
+Sandwich I/O errors specification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+
+enum[SandwichIOError]{
+[SANDWICH_IOERROR_OK]=0,
+[SANDWICH_IOERROR_IN_PROGRESS]=1,
+[SANDWICH_IOERROR_WOULD_BLOCK]=2,
+[SANDWICH_IOERROR_REFUSED]=3,
+[SANDWICH_IOERROR_CLOSED]=4,
+[SANDWICH_IOERROR_INVALID]=5,
+[SANDWICH_IOERROR_UNKNOWN]=6,
+[SANDWICH_IOERROR_SYSTEM_ERROR]=7,
+[SANDWICH_IOERROR_ADDRESS_IN_USE]=8,
+};
+typedefenum[SandwichIOError][SandwichIOError];
+
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/lib_8h.xml b/assets/.doxy/cAPI/xml/lib_8h.xml
new file mode 100755
index 00000000..8ab70cbf
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/lib_8h.xml
@@ -0,0 +1,111 @@
+
+
+
+ lib.h
+ sandwich_c/export.h
+ docs/sandwich_c/sandwich.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] struct SandwichContext *
+ SANDWICH_API struct SandwichContext * sandwich_lib_context_new
+ (void)
+ sandwich_lib_context_new
+
+ void
+
+
+Create a top-level Sandwich context.
+
+
+A new top-level Sandwich context.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_lib_context_free
+ (struct SandwichContext *sw)
+ sandwich_lib_context_free
+
+ struct SandwichContext *
+ sw
+
+
+Free a top-level Sandwich context.
+
+
+
+
+sw
+
+
+Top-level Sandwich context to free.
+
+
+
+NULL for sw is allowed.
+
+
+
+
+
+
+
+Top-level context for the Sandwich library.
+
+
+
+
+
+
+
+#pragmaonce
+
+#include"[sandwich_c/export.h]"
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+
+structSandwichContext;
+
+[SANDWICH_API]structSandwichContext*[sandwich_lib_context_new](void);
+
+[SANDWICH_API]void[sandwich_lib_context_free](structSandwichContext*sw);
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/listener_8h.xml b/assets/.doxy/cAPI/xml/listener_8h.xml
new file mode 100755
index 00000000..1441e251
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/listener_8h.xml
@@ -0,0 +1,287 @@
+
+
+
+ listener.h
+ sys/types.h
+ sandwich_c/export.h
+ sandwich_c/io.h
+ docs/sandwich_c/sandwich.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] struct [SandwichError] *
+ SANDWICH_API struct SandwichError * sandwich_listener_new
+ (const void *src, size_t n, struct SandwichListener **out)
+ sandwich_listener_new
+
+ const void *
+ src
+
+
+ size_t
+ n
+
+
+ struct SandwichListener **
+ out
+
+
+Creates a a new Listener object.
+
+
+
+
+src
+
+
+a serialized ListenerConfiguration protobuf message.
+
+
+
+
+n
+
+
+the length of src.
+
+
+
+
+out
+
+
+points to the newly created listener.
+
+
+
+Error, if any.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichIOError]
+ SANDWICH_API enum SandwichIOError sandwich_listener_listen
+ (struct SandwichListener *listener)
+ sandwich_listener_listen
+
+ struct SandwichListener *
+ listener
+
+
+Causes the Listener to start listening for connections.
+
+
+
+
+listener
+
+
+The listener object that should start listening for new connections.
+
+
+
+IOERROR_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichIOError]
+ SANDWICH_API enum SandwichIOError sandwich_listener_accept
+ (struct SandwichListener *listener, struct SandwichIOOwned **ownedIO)
+ sandwich_listener_accept
+
+ struct SandwichListener *
+ listener
+
+
+ struct [SandwichIOOwned] **
+ ownedIO
+
+
+Prompts the Listener to start accepting connections.
+
+
+
+
+listener
+
+
+the listener which should start accepting connections.
+
+
+
+
+ownedIO
+
+
+the newly created OwnedIO struct containing the IO object to use with a tunnel. Null if an error occurs.
+
+
+
+IOERROR_OK if the operation was a success, otherwise returns the error that occurred.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_listener_close
+ (struct SandwichListener *listener)
+ sandwich_listener_close
+
+ struct SandwichListener *
+ listener
+
+
+Closes the listener to new connections.
+
+
+
+
+listener
+
+
+the listener which should close.
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_listener_free
+ (struct SandwichListener *listener)
+ sandwich_listener_free
+
+ struct SandwichListener *
+ listener
+
+
+Frees the given listener.
+
+
+
+
+listener
+
+
+the listener which should start accepting connections.
+
+
+
+
+
+
+
+
+
+
+
+Sandwich C library, on top of the Rust implementation.
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#include<sys/types.h>
+
+#include"[sandwich_c/export.h]"
+#include"[sandwich_c/io.h]"
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+structSandwichListener;
+
+[SANDWICH_API]struct[SandwichError]*
+[sandwich_listener_new](constvoid*src,size_tn,structSandwichListener**out);
+
+[SANDWICH_API]enum[SandwichIOError]
+[sandwich_listener_listen](structSandwichListener*listener);
+
+[SANDWICH_API]enum[SandwichIOError]
+[sandwich_listener_accept](structSandwichListener*listener,
+struct[SandwichIOOwned]**ownedIO);
+
+[SANDWICH_API]void[sandwich_listener_close](structSandwichListener*listener);
+
+[SANDWICH_API]void[sandwich_listener_free](structSandwichListener*listener);
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/sandwich_8h.xml b/assets/.doxy/cAPI/xml/sandwich_8h.xml
new file mode 100755
index 00000000..37589848
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/sandwich_8h.xml
@@ -0,0 +1,113 @@
+
+
+
+ sandwich.h
+ sandwich_c/error.h
+ sandwich_c/io.h
+ sandwich_c/lib.h
+ sandwich_c/listener.h
+ sandwich_c/tunnel.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Sandwich C library, on top of the Rust implementation.
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#include"[sandwich_c/error.h]"
+#include"[sandwich_c/io.h]"
+#include"[sandwich_c/lib.h]"
+#include"[sandwich_c/listener.h]"
+#include"[sandwich_c/tunnel.h]"
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/structSandwichError.xml b/assets/.doxy/cAPI/xml/structSandwichError.xml
new file mode 100755
index 00000000..9da87f6c
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/structSandwichError.xml
@@ -0,0 +1,90 @@
+
+
+
+ SandwichError
+ error.h
+
+
+ struct [SandwichError] *
+ struct SandwichError* SandwichError::details
+
+ details
+ SandwichError::details
+
+The encapsulated error.
+
+
+
+
+
+
+
+
+ const char *
+ const char* SandwichError::msg
+
+ msg
+ SandwichError::msg
+
+An optional error string.
+
+
+
+
+
+
+
+
+ [SandwichErrorKind]
+ SandwichErrorKind SandwichError::kind
+
+ kind
+ SandwichError::kind
+
+The error kind. See error::ErrorKind enum.
+
+
+
+
+
+
+
+
+ int
+ int SandwichError::code
+
+ code
+ SandwichError::code
+
+The error code.
+
+
+
+
+
+
+
+
+
+An error code.
+
+
+
+
+
+
+
+
+ details
+
+
+
+
+
+ SandwichErrorcode
+ SandwichErrordetails
+ SandwichErrorkind
+ SandwichErrormsg
+
+
+
diff --git a/assets/.doxy/cAPI/xml/structSandwichIO.xml b/assets/.doxy/cAPI/xml/structSandwichIO.xml
new file mode 100755
index 00000000..e364a6bd
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/structSandwichIO.xml
@@ -0,0 +1,82 @@
+
+
+
+ SandwichIO
+ io.h
+
+
+ [SandwichIOReadFunctionPtr]
+ SandwichIOReadFunctionPtr SandwichIO::read
+
+ read
+ SandwichIO::read
+
+The read function.
+
+
+
+
+
+
+
+
+ [SandwichIOWriteFunctionPtr]
+ SandwichIOWriteFunctionPtr SandwichIO::write
+
+ write
+ SandwichIO::write
+
+The write function.
+
+
+
+
+
+
+
+
+ [SandwichIOFlushFunctionPtr]
+ SandwichIOFlushFunctionPtr SandwichIO::flush
+
+ flush
+ SandwichIO::flush
+
+The flush function.
+
+
+NULL is a valid value for flush.
+
+
+
+
+
+
+ void *
+ void* SandwichIO::uarg
+
+ uarg
+ SandwichIO::uarg
+
+Opaque argument to forward to read, write and flush.
+
+
+
+
+
+
+
+
+
+A generic I/O interface.
+
+
+
+
+
+ SandwichIOflush
+ SandwichIOread
+ SandwichIOuarg
+ SandwichIOwrite
+
+
+
diff --git a/assets/.doxy/cAPI/xml/structSandwichIOOwned.xml b/assets/.doxy/cAPI/xml/structSandwichIOOwned.xml
new file mode 100755
index 00000000..985801e7
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/structSandwichIOOwned.xml
@@ -0,0 +1,61 @@
+
+
+
+ SandwichIOOwned
+ io.h
+
+
+ struct [SandwichIO] *
+ struct SandwichIO* SandwichIOOwned::io
+
+ io
+ SandwichIOOwned::io
+
+
+
+
+
+
+
+
+
+ [SandwichOwnedIOFreeFunctionPtr]
+ SandwichOwnedIOFreeFunctionPtr SandwichIOOwned::freeptr
+
+ freeptr
+ SandwichIOOwned::freeptr
+
+
+
+
+
+
+
+
+
+
+An IO owned by the Sandwich Library.
+
+
+[SandwichIOOwned] objects owns the underlying io->uarg object pointer, and provides a freeptr function that is responsible for destroying that object. [SandwichIOOwned] must be freed by calling the [sandwich_io_owned_free] function. This is what is returned from sandwich_io_*_new functions.
+
+
+
+
+
+
+
+
+
+
+ io
+
+
+
+
+
+ SandwichIOOwnedfreeptr
+ SandwichIOOwnedio
+
+
+
diff --git a/assets/.doxy/cAPI/xml/structSandwichTunnelConfigurationSerialized.xml b/assets/.doxy/cAPI/xml/structSandwichTunnelConfigurationSerialized.xml
new file mode 100755
index 00000000..86916d93
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/structSandwichTunnelConfigurationSerialized.xml
@@ -0,0 +1,49 @@
+
+
+
+ SandwichTunnelConfigurationSerialized
+ tunnel.h
+
+
+ const void *
+ const void* SandwichTunnelConfigurationSerialized::src
+
+ src
+ SandwichTunnelConfigurationSerialized::src
+
+Buffer containing the serialized TunnelConfiguration message.
+
+
+
+
+
+
+
+
+ size_t
+ size_t SandwichTunnelConfigurationSerialized::n
+
+ n
+ SandwichTunnelConfigurationSerialized::n
+
+Size of src.
+
+
+
+
+
+
+
+
+
+A serialized TunnelConfiguration message.
+
+
+
+
+
+ SandwichTunnelConfigurationSerializedn
+ SandwichTunnelConfigurationSerializedsrc
+
+
+
diff --git a/assets/.doxy/cAPI/xml/structSandwichTunnelContextConfigurationSerialized.xml b/assets/.doxy/cAPI/xml/structSandwichTunnelContextConfigurationSerialized.xml
new file mode 100755
index 00000000..ac17e549
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/structSandwichTunnelContextConfigurationSerialized.xml
@@ -0,0 +1,49 @@
+
+
+
+ SandwichTunnelContextConfigurationSerialized
+ tunnel.h
+
+
+ const void *
+ const void* SandwichTunnelContextConfigurationSerialized::src
+
+ src
+ SandwichTunnelContextConfigurationSerialized::src
+
+Buffer containing the serialized Configuration message.
+
+
+
+
+
+
+
+
+ size_t
+ size_t SandwichTunnelContextConfigurationSerialized::n
+
+ n
+ SandwichTunnelContextConfigurationSerialized::n
+
+Size of src.
+
+
+
+
+
+
+
+
+
+A serialized Configuration message.
+
+
+
+
+
+ SandwichTunnelContextConfigurationSerializedn
+ SandwichTunnelContextConfigurationSerializedsrc
+
+
+
diff --git a/assets/.doxy/cAPI/xml/tunnel_8h.xml b/assets/.doxy/cAPI/xml/tunnel_8h.xml
new file mode 100755
index 00000000..b756374a
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/tunnel_8h.xml
@@ -0,0 +1,576 @@
+
+
+
+ tunnel.h
+ sys/types.h
+ sandwich_c/export.h
+ sandwich_c/io.h
+ sandwich_c/tunnel_types.h
+ docs/sandwich_c/sandwich.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichTunnelContextConfigurationSerialized
+ SandwichTunnelConfigurationSerialized
+
+
+ struct [SandwichTunnelConfigurationSerialized]
+ struct SandwichTunnelConfigurationSerialized SandwichTunnelConfigurationVerifierEmpty
+
+ SandwichTunnelConfigurationVerifierEmpty
+
+A tunnel configuration containing an empty Tunnel Verifier.
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] struct [SandwichError] *
+ SANDWICH_API struct SandwichError * sandwich_tunnel_context_new
+ (const struct SandwichContext *sw, struct SandwichTunnelContextConfigurationSerialized configuration, struct SandwichTunnelContext **ctx)
+ sandwich_tunnel_context_new
+
+ const struct SandwichContext *
+ sw
+
+
+ struct [SandwichTunnelContextConfigurationSerialized]
+ configuration
+
+
+ struct SandwichTunnelContext **
+ ctx
+
+
+Create a context from an encoded protobuf message.
+
+
+
+
+sw
+
+
+Top-level Sandwich context.
+
+
+
+
+configuration
+
+
+Serialized configuration.
+
+
+
+
+ctx
+
+
+The new Sandwich context object.
+
+
+
+NULL if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_tunnel_context_free
+ (struct SandwichTunnelContext *ctx)
+ sandwich_tunnel_context_free
+
+ struct SandwichTunnelContext *
+ ctx
+
+
+Free a Sandwich tunnel context.
+
+
+
+
+ctx
+
+
+Context to free.
+
+
+
+NULL for ctx is allowed.
+
+
+
+
+
+
+ [SANDWICH_API] struct [SandwichError] *
+ SANDWICH_API struct SandwichError * sandwich_tunnel_new
+ (struct SandwichTunnelContext *ctx, const struct SandwichIO *io, struct SandwichTunnelConfigurationSerialized configuration, struct SandwichTunnel **tun)
+ sandwich_tunnel_new
+
+ struct SandwichTunnelContext *
+ ctx
+
+
+ const struct [SandwichIO] *
+ io
+
+
+ struct [SandwichTunnelConfigurationSerialized]
+ configuration
+
+
+ struct SandwichTunnel **
+ tun
+
+
+Create a tunnel.
+
+
+A tunnel is created from an I/O interface. [SandwichIO] are used to create an I/O interface that forwards calls to the read, and write of [SandwichIO].
+Since the implementation of sandwich_tunnel_new makes a copy of [SandwichIO], the caller does not need to keep io in memory. In other words, Sandwich does not take the ownership of io.
+
+
+ctx
+
+
+Sandwich context used for setting up the tunnel.
+
+
+
+
+io
+
+
+I/O interface to use to create the I/O interface.
+
+
+
+
+configuration
+
+
+Additional configuration the connection is subject to. A null pointer is undefined behavior.
+
+
+
+
+tun
+
+
+The new Sandwich tunnel object.
+
+
+
+NULL if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] struct [SandwichError] *
+ SANDWICH_API struct SandwichError * sandwich_tunnel_handshake
+ (struct SandwichTunnel *tun, enum SandwichTunnelHandshakeState *state)
+ sandwich_tunnel_handshake
+
+ struct SandwichTunnel *
+ tun
+
+
+ enum [SandwichTunnelHandshakeState] *
+ state
+
+
+Perform the handshake.
+
+
+
+
+tun
+
+
+Tunnel.
+
+
+
+
+state
+
+
+The state of the tunnel
+
+
+
+Null if no error occured, else a chain of errors.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichTunnelRecordError]
+ SANDWICH_API enum SandwichTunnelRecordError sandwich_tunnel_read
+ (struct SandwichTunnel *tun, void *dst, size_t n, size_t *r)
+ sandwich_tunnel_read
+
+ struct SandwichTunnel *
+ tun
+
+
+ void *
+ dst
+
+
+ size_t
+ n
+
+
+ size_t *
+ r
+
+
+Read some bytes from the record plane of the tunnel.
+
+
+
+
+tun
+
+
+Tunnel..
+
+
+
+
+dst
+
+
+Destination buffer.
+
+
+
+
+n
+
+
+Amount of bytes to read.
+
+
+
+
+r
+
+
+Amount of bytes successfully read.
+
+
+
+NULL for r is allowed.
+An error code.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichTunnelRecordError]
+ SANDWICH_API enum SandwichTunnelRecordError sandwich_tunnel_write
+ (struct SandwichTunnel *tun, const void *src, size_t n, size_t *w)
+ sandwich_tunnel_write
+
+ struct SandwichTunnel *
+ tun
+
+
+ const void *
+ src
+
+
+ size_t
+ n
+
+
+ size_t *
+ w
+
+
+Write some bytes to the record plane of the tunnel.
+
+
+
+
+tun
+
+
+Tunnel.
+
+
+
+
+src
+
+
+Source buffer.
+
+
+
+
+n
+
+
+Amount of bytes to read.
+
+
+
+
+w
+
+
+Amount of bytes successfully written.
+
+
+
+NULL for w is allowed.
+An error code.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_tunnel_close
+ (struct SandwichTunnel *tun)
+ sandwich_tunnel_close
+
+ struct SandwichTunnel *
+ tun
+
+
+Close the tunnel.
+
+
+
+
+tun
+
+
+Tunnel to close.
+
+
+
+
+
+
+
+
+
+
+ [SANDWICH_API] enum [SandwichTunnelState]
+ SANDWICH_API enum SandwichTunnelState sandwich_tunnel_state
+ (const struct SandwichTunnel *tun)
+ sandwich_tunnel_state
+
+ const struct SandwichTunnel *
+ tun
+
+
+Get the state of the tunnel.
+
+
+
+
+tun
+
+
+Tunnel.
+
+
+
+The state of the tunnel.
+
+
+
+
+
+
+
+
+ [SANDWICH_API] void
+ SANDWICH_API void sandwich_tunnel_free
+ (struct SandwichTunnel *tun)
+ sandwich_tunnel_free
+
+ struct SandwichTunnel *
+ tun
+
+
+Free a Sandwich tunnel.
+
+
+If the I/O interface is still owned by the tunnel, it will be freed too.
+
+
+tun
+
+
+Tunnel to free.
+
+
+
+NULL for tun is allowed.
+
+
+
+
+
+
+
+Sandwich Tunnel API.
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#include<sys/types.h>
+
+#include"[sandwich_c/export.h]"
+#include"[sandwich_c/io.h]"
+#include"[sandwich_c/tunnel_types.h]"
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+structSandwichTunnelContext;
+
+struct[SandwichTunnelContextConfigurationSerialized]{
+constvoid*[src];
+
+size_t[n];
+};
+
+struct[SandwichTunnelConfigurationSerialized]{
+constvoid*[src];
+
+size_t[n];
+};
+
+externstruct[SandwichTunnelConfigurationSerialized]
+[SandwichTunnelConfigurationVerifierEmpty];
+
+structSandwichTunnel;
+
+[SANDWICH_API]struct[SandwichError]*[sandwich_tunnel_context_new](
+conststructSandwichContext*sw,
+struct[SandwichTunnelContextConfigurationSerialized]configuration,
+structSandwichTunnelContext**ctx);
+
+[SANDWICH_API]void
+[sandwich_tunnel_context_free](structSandwichTunnelContext*ctx);
+
+[SANDWICH_API]struct[SandwichError]*
+[sandwich_tunnel_new](structSandwichTunnelContext*ctx,
+conststruct[SandwichIO]*io,
+struct[SandwichTunnelConfigurationSerialized]configuration,
+structSandwichTunnel**tun);
+
+[SANDWICH_API]struct[SandwichError]*
+[sandwich_tunnel_handshake](structSandwichTunnel*tun,
+enum[SandwichTunnelHandshakeState]*state);
+
+[SANDWICH_API]enum[SandwichTunnelRecordError]
+[sandwich_tunnel_read](structSandwichTunnel*tun,void*dst,size_tn,
+size_t*r);
+
+[SANDWICH_API]enum[SandwichTunnelRecordError]
+[sandwich_tunnel_write](structSandwichTunnel*tun,constvoid*src,size_tn,
+size_t*w);
+
+[SANDWICH_API]void[sandwich_tunnel_close](structSandwichTunnel*tun);
+
+[SANDWICH_API]enum[SandwichTunnelState]
+[sandwich_tunnel_state](conststructSandwichTunnel*tun);
+
+[SANDWICH_API]void[sandwich_tunnel_free](structSandwichTunnel*tun);
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/tunnel__types_8h.xml b/assets/.doxy/cAPI/xml/tunnel__types_8h.xml
new file mode 100755
index 00000000..3bbba6e8
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/tunnel__types_8h.xml
@@ -0,0 +1,339 @@
+
+
+
+ tunnel_types.h
+ docs/sandwich_c/io.h
+ docs/sandwich_c/tunnel.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SandwichTunnelState
+
+ SANDWICH_TUNNEL_STATE_NOT_CONNECTED
+ = 0
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_CONNECTION_IN_PROGRESS
+ = 1
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_IN_PROGRESS
+ = 2
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_HANDSHAKE_DONE
+ = 3
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_BEING_SHUTDOWN
+ = 4
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_DISCONNECTED
+ = 5
+
+
+
+
+
+
+ SANDWICH_TUNNEL_STATE_ERROR
+ = 6
+
+
+
+
+
+
+Enum State.
+
+
+
+
+
+
+
+
+
+ SandwichTunnelHandshakeState
+
+ SANDWICH_TUNNEL_HANDSHAKESTATE_IN_PROGRESS
+ = 0
+
+
+
+
+
+
+ SANDWICH_TUNNEL_HANDSHAKESTATE_DONE
+ = 1
+
+
+
+
+
+
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_READ
+ = 2
+
+
+
+
+
+
+ SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_WRITE
+ = 3
+
+
+
+
+
+
+ SANDWICH_TUNNEL_HANDSHAKESTATE_ERROR
+ = 4
+
+
+
+
+
+
+Enum HandshakeState.
+
+
+
+
+
+
+
+
+
+ SandwichTunnelRecordError
+
+ SANDWICH_TUNNEL_RECORDERROR_OK
+ = 0
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_WANT_READ
+ = 1
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_WANT_WRITE
+ = 2
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_BEING_SHUTDOWN
+ = 3
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_CLOSED
+ = 4
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_TOO_BIG
+ = 5
+
+
+
+
+
+
+ SANDWICH_TUNNEL_RECORDERROR_UNKNOWN
+ = 6
+
+
+
+
+
+
+Enum RecordError.
+
+
+
+
+
+
+
+
+
+
+ enum [SandwichTunnelState]
+ typedef enum SandwichTunnelState SandwichTunnelState
+
+ SandwichTunnelState
+
+
+
+
+
+
+
+
+
+ enum [SandwichTunnelHandshakeState]
+ typedef enum SandwichTunnelHandshakeState SandwichTunnelHandshakeState
+
+ SandwichTunnelHandshakeState
+
+
+
+
+
+
+
+
+
+ enum [SandwichTunnelRecordError]
+ typedef enum SandwichTunnelRecordError SandwichTunnelRecordError
+
+ SandwichTunnelRecordError
+
+
+
+
+
+
+
+
+
+
+Sandwich tunnel types and states specification.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+#pragmaonce
+
+#ifdef__cplusplus
+extern"C"{
+#endif
+
+
+enum[SandwichTunnelState]{
+[SANDWICH_TUNNEL_STATE_NOT_CONNECTED]=0,
+[SANDWICH_TUNNEL_STATE_CONNECTION_IN_PROGRESS]=1,
+[SANDWICH_TUNNEL_STATE_HANDSHAKE_IN_PROGRESS]=2,
+[SANDWICH_TUNNEL_STATE_HANDSHAKE_DONE]=3,
+[SANDWICH_TUNNEL_STATE_BEING_SHUTDOWN]=4,
+[SANDWICH_TUNNEL_STATE_DISCONNECTED]=5,
+[SANDWICH_TUNNEL_STATE_ERROR]=6,
+};
+typedefenum[SandwichTunnelState][SandwichTunnelState];
+
+enum[SandwichTunnelHandshakeState]{
+[SANDWICH_TUNNEL_HANDSHAKESTATE_IN_PROGRESS]=0,
+[SANDWICH_TUNNEL_HANDSHAKESTATE_DONE]=1,
+[SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_READ]=2,
+[SANDWICH_TUNNEL_HANDSHAKESTATE_WANT_WRITE]=3,
+[SANDWICH_TUNNEL_HANDSHAKESTATE_ERROR]=4,
+};
+typedefenum[SandwichTunnelHandshakeState][SandwichTunnelHandshakeState];
+
+enum[SandwichTunnelRecordError]{
+[SANDWICH_TUNNEL_RECORDERROR_OK]=0,
+[SANDWICH_TUNNEL_RECORDERROR_WANT_READ]=1,
+[SANDWICH_TUNNEL_RECORDERROR_WANT_WRITE]=2,
+[SANDWICH_TUNNEL_RECORDERROR_BEING_SHUTDOWN]=3,
+[SANDWICH_TUNNEL_RECORDERROR_CLOSED]=4,
+[SANDWICH_TUNNEL_RECORDERROR_TOO_BIG]=5,
+[SANDWICH_TUNNEL_RECORDERROR_UNKNOWN]=6,
+};
+typedefenum[SandwichTunnelRecordError][SandwichTunnelRecordError];
+
+
+#ifdef__cplusplus
+}
+#endif
+
+
+
+
diff --git a/assets/.doxy/cAPI/xml/xml.xsd b/assets/.doxy/cAPI/xml/xml.xsd
new file mode 100755
index 00000000..9f80fe15
--- /dev/null
+++ b/assets/.doxy/cAPI/xml/xml.xsd
@@ -0,0 +1,23 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
new file mode 100755
index 00000000..049a254b
--- /dev/null
+++ b/assets/_mkdocstrings.css
@@ -0,0 +1,64 @@
+
+/* Avoid breaking parameter names, etc. in table cells. */
+.doc-contents td code {
+ word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+ display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+ display: table !important;
+ width: 100%;
+}
+
+.doc .md-typeset__table tr {
+ display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-param-default {
+ float: right;
+}
+
+/* Keep headings consistent. */
+h1.doc-heading,
+h2.doc-heading,
+h3.doc-heading,
+h4.doc-heading,
+h5.doc-heading,
+h6.doc-heading {
+ font-weight: 400;
+ line-height: 1.5;
+ color: inherit;
+ text-transform: none;
+}
+
+h1.doc-heading {
+ font-size: 1.6rem;
+}
+
+h2.doc-heading {
+ font-size: 1.2rem;
+}
+
+h3.doc-heading {
+ font-size: 1.15rem;
+}
+
+h4.doc-heading {
+ font-size: 1.10rem;
+}
+
+h5.doc-heading {
+ font-size: 1.05rem;
+}
+
+h6.doc-heading {
+ font-size: 1rem;
+}
\ No newline at end of file
diff --git a/assets/images/favicon.png b/assets/images/favicon.png
new file mode 100755
index 00000000..1cf13b9f
Binary files /dev/null and b/assets/images/favicon.png differ
diff --git a/assets/javascripts/bundle.dff1b7c8.min.js b/assets/javascripts/bundle.dff1b7c8.min.js
new file mode 100755
index 00000000..a89e799a
--- /dev/null
+++ b/assets/javascripts/bundle.dff1b7c8.min.js
@@ -0,0 +1,29 @@
+"use strict";(()=>{var gi=Object.create;var dr=Object.defineProperty;var xi=Object.getOwnPropertyDescriptor;var yi=Object.getOwnPropertyNames,Ht=Object.getOwnPropertySymbols,Ei=Object.getPrototypeOf,hr=Object.prototype.hasOwnProperty,Xr=Object.prototype.propertyIsEnumerable;var Jr=(e,t,r)=>t in e?dr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,I=(e,t)=>{for(var r in t||(t={}))hr.call(t,r)&&Jr(e,r,t[r]);if(Ht)for(var r of Ht(t))Xr.call(t,r)&&Jr(e,r,t[r]);return e};var Zr=(e,t)=>{var r={};for(var o in e)hr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Ht)for(var o of Ht(e))t.indexOf(o)<0&&Xr.call(e,o)&&(r[o]=e[o]);return r};var br=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var wi=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of yi(t))!hr.call(e,n)&&n!==r&&dr(e,n,{get:()=>t[n],enumerable:!(o=xi(t,n))||o.enumerable});return e};var $t=(e,t,r)=>(r=e!=null?gi(Ei(e)):{},wi(t||!e||!e.__esModule?dr(r,"default",{value:e,enumerable:!0}):r,e));var to=br((vr,eo)=>{(function(e,t){typeof vr=="object"&&typeof eo!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(vr,function(){"use strict";function e(r){var o=!0,n=!1,i=null,s={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function a(A){return!!(A&&A!==document&&A.nodeName!=="HTML"&&A.nodeName!=="BODY"&&"classList"in A&&"contains"in A.classList)}function c(A){var it=A.type,Ne=A.tagName;return!!(Ne==="INPUT"&&s[it]&&!A.readOnly||Ne==="TEXTAREA"&&!A.readOnly||A.isContentEditable)}function p(A){A.classList.contains("focus-visible")||(A.classList.add("focus-visible"),A.setAttribute("data-focus-visible-added",""))}function m(A){A.hasAttribute("data-focus-visible-added")&&(A.classList.remove("focus-visible"),A.removeAttribute("data-focus-visible-added"))}function f(A){A.metaKey||A.altKey||A.ctrlKey||(a(r.activeElement)&&p(r.activeElement),o=!0)}function u(A){o=!1}function d(A){a(A.target)&&(o||c(A.target))&&p(A.target)}function b(A){a(A.target)&&(A.target.classList.contains("focus-visible")||A.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),m(A.target))}function _(A){document.visibilityState==="hidden"&&(n&&(o=!0),re())}function re(){document.addEventListener("mousemove",Y),document.addEventListener("mousedown",Y),document.addEventListener("mouseup",Y),document.addEventListener("pointermove",Y),document.addEventListener("pointerdown",Y),document.addEventListener("pointerup",Y),document.addEventListener("touchmove",Y),document.addEventListener("touchstart",Y),document.addEventListener("touchend",Y)}function Z(){document.removeEventListener("mousemove",Y),document.removeEventListener("mousedown",Y),document.removeEventListener("mouseup",Y),document.removeEventListener("pointermove",Y),document.removeEventListener("pointerdown",Y),document.removeEventListener("pointerup",Y),document.removeEventListener("touchmove",Y),document.removeEventListener("touchstart",Y),document.removeEventListener("touchend",Y)}function Y(A){A.target.nodeName&&A.target.nodeName.toLowerCase()==="html"||(o=!1,Z())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",_,!0),re(),r.addEventListener("focus",d,!0),r.addEventListener("blur",b,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Vr=br((Mt,Dr)=>{/*!
+ * clipboard.js v2.0.11
+ * https://clipboardjs.com/
+ *
+ * Licensed MIT © Zeno Rocha
+ */(function(t,r){typeof Mt=="object"&&typeof Dr=="object"?Dr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Mt=="object"?Mt.ClipboardJS=r():t.ClipboardJS=r()})(Mt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return vi}});var s=i(279),a=i.n(s),c=i(370),p=i.n(c),m=i(817),f=i.n(m);function u(F){try{return document.execCommand(F)}catch(S){return!1}}var d=function(S){var y=f()(S);return u("cut"),y},b=d;function _(F){var S=document.documentElement.getAttribute("dir")==="rtl",y=document.createElement("textarea");y.style.fontSize="12pt",y.style.border="0",y.style.padding="0",y.style.margin="0",y.style.position="absolute",y.style[S?"right":"left"]="-9999px";var R=window.pageYOffset||document.documentElement.scrollTop;return y.style.top="".concat(R,"px"),y.setAttribute("readonly",""),y.value=F,y}var re=function(S,y){var R=_(S);y.container.appendChild(R);var P=f()(R);return u("copy"),R.remove(),P},Z=function(S){var y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},R="";return typeof S=="string"?R=re(S,y):S instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(S==null?void 0:S.type)?R=re(S.value,y):(R=f()(S),u("copy")),R},Y=Z;function A(F){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?A=function(y){return typeof y}:A=function(y){return y&&typeof Symbol=="function"&&y.constructor===Symbol&&y!==Symbol.prototype?"symbol":typeof y},A(F)}var it=function(){var S=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},y=S.action,R=y===void 0?"copy":y,P=S.container,q=S.target,Me=S.text;if(R!=="copy"&&R!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&A(q)==="object"&&q.nodeType===1){if(R==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(R==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Me)return Y(Me,{container:P});if(q)return R==="cut"?b(q):Y(q,{container:P})},Ne=it;function Ie(F){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(y){return typeof y}:Ie=function(y){return y&&typeof Symbol=="function"&&y.constructor===Symbol&&y!==Symbol.prototype?"symbol":typeof y},Ie(F)}function pi(F,S){if(!(F instanceof S))throw new TypeError("Cannot call a class as a function")}function Gr(F,S){for(var y=0;y0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof P.action=="function"?P.action:this.defaultAction,this.target=typeof P.target=="function"?P.target:this.defaultTarget,this.text=typeof P.text=="function"?P.text:this.defaultText,this.container=Ie(P.container)==="object"?P.container:document.body}},{key:"listenClick",value:function(P){var q=this;this.listener=p()(P,"click",function(Me){return q.onClick(Me)})}},{key:"onClick",value:function(P){var q=P.delegateTarget||P.currentTarget,Me=this.action(q)||"copy",kt=Ne({action:Me,container:this.container,target:this.target(q),text:this.text(q)});this.emit(kt?"success":"error",{action:Me,text:kt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(P){return ur("action",P)}},{key:"defaultTarget",value:function(P){var q=ur("target",P);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(P){return ur("text",P)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(P){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return Y(P,q)}},{key:"cut",value:function(P){return b(P)}},{key:"isSupported",value:function(){var P=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof P=="string"?[P]:P,Me=!!document.queryCommandSupported;return q.forEach(function(kt){Me=Me&&!!document.queryCommandSupported(kt)}),Me}}]),y}(a()),vi=bi},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function s(a,c){for(;a&&a.nodeType!==n;){if(typeof a.matches=="function"&&a.matches(c))return a;a=a.parentNode}}o.exports=s},438:function(o,n,i){var s=i(828);function a(m,f,u,d,b){var _=p.apply(this,arguments);return m.addEventListener(u,_,b),{destroy:function(){m.removeEventListener(u,_,b)}}}function c(m,f,u,d,b){return typeof m.addEventListener=="function"?a.apply(null,arguments):typeof u=="function"?a.bind(null,document).apply(null,arguments):(typeof m=="string"&&(m=document.querySelectorAll(m)),Array.prototype.map.call(m,function(_){return a(_,f,u,d,b)}))}function p(m,f,u,d){return function(b){b.delegateTarget=s(b.target,f),b.delegateTarget&&d.call(m,b)}}o.exports=c},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var s=Object.prototype.toString.call(i);return i!==void 0&&(s==="[object NodeList]"||s==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var s=Object.prototype.toString.call(i);return s==="[object Function]"}},370:function(o,n,i){var s=i(879),a=i(438);function c(u,d,b){if(!u&&!d&&!b)throw new Error("Missing required arguments");if(!s.string(d))throw new TypeError("Second argument must be a String");if(!s.fn(b))throw new TypeError("Third argument must be a Function");if(s.node(u))return p(u,d,b);if(s.nodeList(u))return m(u,d,b);if(s.string(u))return f(u,d,b);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function p(u,d,b){return u.addEventListener(d,b),{destroy:function(){u.removeEventListener(d,b)}}}function m(u,d,b){return Array.prototype.forEach.call(u,function(_){_.addEventListener(d,b)}),{destroy:function(){Array.prototype.forEach.call(u,function(_){_.removeEventListener(d,b)})}}}function f(u,d,b){return a(document.body,u,d,b)}o.exports=c},817:function(o){function n(i){var s;if(i.nodeName==="SELECT")i.focus(),s=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var a=i.hasAttribute("readonly");a||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),a||i.removeAttribute("readonly"),s=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),p=document.createRange();p.selectNodeContents(i),c.removeAllRanges(),c.addRange(p),s=c.toString()}return s}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,s,a){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:s,ctx:a}),this},once:function(i,s,a){var c=this;function p(){c.off(i,p),s.apply(a,arguments)}return p._=s,this.on(i,p,a)},emit:function(i){var s=[].slice.call(arguments,1),a=((this.e||(this.e={}))[i]||[]).slice(),c=0,p=a.length;for(c;c{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var _a=/["'&<>]/;Pn.exports=Aa;function Aa(e){var t=""+e,r=_a.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i0&&i[i.length-1])&&(p[0]===6||p[0]===2)){r=0;continue}if(p[0]===3&&(!i||p[1]>i[0]&&p[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function U(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],s;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(a){s={error:a}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(s)throw s.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||a(u,d)})})}function a(u,d){try{c(o[u](d))}catch(b){f(i[0][3],b)}}function c(u){u.value instanceof Ze?Promise.resolve(u.value.v).then(p,m):f(i[0][2],u)}function p(u){a("next",u)}function m(u){a("throw",u)}function f(u,d){u(d),i.shift(),i.length&&a(i[0][0],i[0][1])}}function no(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof Ee=="function"?Ee(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(s){return new Promise(function(a,c){s=e[i](s),n(a,c,s.done,s.value)})}}function n(i,s,a,c){Promise.resolve(c).then(function(p){i({value:p,done:a})},s)}}function C(e){return typeof e=="function"}function at(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var It=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription:
+`+r.map(function(o,n){return n+1+") "+o.toString()}).join(`
+ `):"",this.name="UnsubscriptionError",this.errors=r}});function De(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Pe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var s=this._parentage;if(s)if(this._parentage=null,Array.isArray(s))try{for(var a=Ee(s),c=a.next();!c.done;c=a.next()){var p=c.value;p.remove(this)}}catch(_){t={error:_}}finally{try{c&&!c.done&&(r=a.return)&&r.call(a)}finally{if(t)throw t.error}}else s.remove(this);var m=this.initialTeardown;if(C(m))try{m()}catch(_){i=_ instanceof It?_.errors:[_]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=Ee(f),d=u.next();!d.done;d=u.next()){var b=d.value;try{io(b)}catch(_){i=i!=null?i:[],_ instanceof It?i=D(D([],U(i)),U(_.errors)):i.push(_)}}}catch(_){o={error:_}}finally{try{d&&!d.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new It(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)io(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&De(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&De(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var xr=Pe.EMPTY;function Pt(e){return e instanceof Pe||e&&"closed"in e&&C(e.remove)&&C(e.add)&&C(e.unsubscribe)}function io(e){C(e)?e():e.unsubscribe()}var Le={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,s=n.isStopped,a=n.observers;return i||s?xr:(this.currentObservers=null,a.push(r),new Pe(function(){o.currentObservers=null,De(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,s=o.isStopped;n?r.error(i):s&&r.complete()},t.prototype.asObservable=function(){var r=new j;return r.source=this,r},t.create=function(r,o){return new uo(r,o)},t}(j);var uo=function(e){ie(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:xr},t}(x);var yt={now:function(){return(yt.delegate||Date).now()},delegate:void 0};var Et=function(e){ie(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=yt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,s=o._infiniteTimeWindow,a=o._timestampProvider,c=o._windowTime;n||(i.push(r),!s&&i.push(a.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,s=n._buffer,a=s.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=mt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var s=r.actions;o!=null&&((i=s[s.length-1])===null||i===void 0?void 0:i.id)!==o&&(mt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(Wt);var vo=function(e){ie(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(Ut);var Te=new vo(bo);var T=new j(function(e){return e.complete()});function Nt(e){return e&&C(e.schedule)}function Mr(e){return e[e.length-1]}function Qe(e){return C(Mr(e))?e.pop():void 0}function Oe(e){return Nt(Mr(e))?e.pop():void 0}function Dt(e,t){return typeof Mr(e)=="number"?e.pop():t}var lt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Vt(e){return C(e==null?void 0:e.then)}function zt(e){return C(e[pt])}function qt(e){return Symbol.asyncIterator&&C(e==null?void 0:e[Symbol.asyncIterator])}function Kt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function ki(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qt=ki();function Yt(e){return C(e==null?void 0:e[Qt])}function Bt(e){return oo(this,arguments,function(){var r,o,n,i;return Rt(this,function(s){switch(s.label){case 0:r=e.getReader(),s.label=1;case 1:s.trys.push([1,,9,10]),s.label=2;case 2:return[4,Ze(r.read())];case 3:return o=s.sent(),n=o.value,i=o.done,i?[4,Ze(void 0)]:[3,5];case 4:return[2,s.sent()];case 5:return[4,Ze(n)];case 6:return[4,s.sent()];case 7:return s.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Gt(e){return C(e==null?void 0:e.getReader)}function W(e){if(e instanceof j)return e;if(e!=null){if(zt(e))return Hi(e);if(lt(e))return $i(e);if(Vt(e))return Ri(e);if(qt(e))return go(e);if(Yt(e))return Ii(e);if(Gt(e))return Pi(e)}throw Kt(e)}function Hi(e){return new j(function(t){var r=e[pt]();if(C(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function $i(e){return new j(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?L(function(n,i){return e(n,i,o)}):de,ge(1),r?He(t):Io(function(){return new Xt}))}}function Po(){for(var e=[],t=0;t=2,!0))}function le(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new x}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,s=i===void 0?!0:i,a=e.resetOnRefCountZero,c=a===void 0?!0:a;return function(p){var m,f,u,d=0,b=!1,_=!1,re=function(){f==null||f.unsubscribe(),f=void 0},Z=function(){re(),m=u=void 0,b=_=!1},Y=function(){var A=m;Z(),A==null||A.unsubscribe()};return g(function(A,it){d++,!_&&!b&&re();var Ne=u=u!=null?u:r();it.add(function(){d--,d===0&&!_&&!b&&(f=kr(Y,c))}),Ne.subscribe(it),!m&&d>0&&(m=new tt({next:function(Ie){return Ne.next(Ie)},error:function(Ie){_=!0,re(),f=kr(Z,n,Ie),Ne.error(Ie)},complete:function(){b=!0,re(),f=kr(Z,s),Ne.complete()}}),W(A).subscribe(m))})(p)}}function kr(e,t){for(var r=[],o=2;oe.next(document)),e}function z(e,t=document){return Array.from(t.querySelectorAll(e))}function N(e,t=document){let r=ce(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function ce(e,t=document){return t.querySelector(e)||void 0}function Re(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}var ea=M(h(document.body,"focusin"),h(document.body,"focusout")).pipe(ke(1),V(void 0),l(()=>Re()||document.body),B(1));function er(e){return ea.pipe(l(t=>e.contains(t)),G())}function Je(e){return{x:e.offsetLeft,y:e.offsetTop}}function Uo(e){return M(h(window,"load"),h(window,"resize")).pipe(Ae(0,Te),l(()=>Je(e)),V(Je(e)))}function tr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return M(h(e,"scroll"),h(window,"resize")).pipe(Ae(0,Te),l(()=>tr(e)),V(tr(e)))}function No(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)No(e,r)}function O(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)No(o,n);return o}function rr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function ht(e){let t=O("script",{src:e});return $(()=>(document.head.appendChild(t),M(h(t,"load"),h(t,"error").pipe(v(()=>St(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),k(()=>document.head.removeChild(t)),ge(1))))}var Do=new x,ta=$(()=>typeof ResizeObserver=="undefined"?ht("https://unpkg.com/resize-observer-polyfill"):H(void 0)).pipe(l(()=>new ResizeObserver(e=>{for(let t of e)Do.next(t)})),v(e=>M(Ve,H(e)).pipe(k(()=>e.disconnect()))),B(1));function he(e){return{width:e.offsetWidth,height:e.offsetHeight}}function xe(e){return ta.pipe(w(t=>t.observe(e)),v(t=>Do.pipe(L(({target:r})=>r===e),k(()=>t.unobserve(e)),l(()=>he(e)))),V(he(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function or(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var Vo=new x,ra=$(()=>H(new IntersectionObserver(e=>{for(let t of e)Vo.next(t)},{threshold:0}))).pipe(v(e=>M(Ve,H(e)).pipe(k(()=>e.disconnect()))),B(1));function nr(e){return ra.pipe(w(t=>t.observe(e)),v(t=>Vo.pipe(L(({target:r})=>r===e),k(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function zo(e,t=16){return dt(e).pipe(l(({y:r})=>{let o=he(e),n=bt(e);return r>=n.height-o.height-t}),G())}var ir={drawer:N("[data-md-toggle=drawer]"),search:N("[data-md-toggle=search]")};function qo(e){return ir[e].checked}function Ke(e,t){ir[e].checked!==t&&ir[e].click()}function We(e){let t=ir[e];return h(t,"change").pipe(l(()=>t.checked),V(t.checked))}function oa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function na(){return M(h(window,"compositionstart").pipe(l(()=>!0)),h(window,"compositionend").pipe(l(()=>!1))).pipe(V(!1))}function Ko(){let e=h(window,"keydown").pipe(L(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:qo("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),L(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!oa(o,r)}return!0}),le());return na().pipe(v(t=>t?T:e))}function fe(){return new URL(location.href)}function ot(e){location.href=e.href}function Qo(){return new x}function Yo(){return location.hash.slice(1)}function Pr(e){let t=O("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function ia(e){return M(h(window,"hashchange"),e).pipe(l(Yo),V(Yo()),L(t=>t.length>0),B(1))}function Bo(e){return ia(e).pipe(l(t=>ce(`[id="${t}"]`)),L(t=>typeof t!="undefined"))}function Fr(e){let t=matchMedia(e);return Zt(r=>t.addListener(()=>r(t.matches))).pipe(V(t.matches))}function Go(){let e=matchMedia("print");return M(h(window,"beforeprint").pipe(l(()=>!0)),h(window,"afterprint").pipe(l(()=>!1))).pipe(V(e.matches))}function jr(e,t){return e.pipe(v(r=>r?t():T))}function ar(e,t={credentials:"same-origin"}){return me(fetch(`${e}`,t)).pipe(pe(()=>T),v(r=>r.status!==200?St(()=>new Error(r.statusText)):H(r)))}function Ue(e,t){return ar(e,t).pipe(v(r=>r.json()),B(1))}function Jo(e,t){let r=new DOMParser;return ar(e,t).pipe(v(o=>o.text()),l(o=>r.parseFromString(o,"text/xml")),B(1))}function Xo(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function Zo(){return M(h(window,"scroll",{passive:!0}),h(window,"resize",{passive:!0})).pipe(l(Xo),V(Xo()))}function en(){return{width:innerWidth,height:innerHeight}}function tn(){return h(window,"resize",{passive:!0}).pipe(l(en),V(en()))}function rn(){return Q([Zo(),tn()]).pipe(l(([e,t])=>({offset:e,size:t})),B(1))}function sr(e,{viewport$:t,header$:r}){let o=t.pipe(X("size")),n=Q([o,r]).pipe(l(()=>Je(e)));return Q([r,t,n]).pipe(l(([{height:i},{offset:s,size:a},{x:c,y:p}])=>({offset:{x:s.x-c,y:s.y-p+i},size:a})))}function aa(e){return h(e,"message",t=>t.data)}function sa(e){let t=new x;return t.subscribe(r=>e.postMessage(r)),t}function on(e,t=new Worker(e)){let r=aa(t),o=sa(t),n=new x;n.subscribe(o);let i=o.pipe(J(),ee(!0));return n.pipe(J(),qe(r.pipe(K(i))),le())}var ca=N("#__config"),vt=JSON.parse(ca.textContent);vt.base=`${new URL(vt.base,fe())}`;function ue(){return vt}function te(e){return vt.features.includes(e)}function be(e,t){return typeof t!="undefined"?vt.translations[e].replace("#",t.toString()):vt.translations[e]}function ye(e,t=document){return N(`[data-md-component=${e}]`,t)}function ne(e,t=document){return z(`[data-md-component=${e}]`,t)}function pa(e){let t=N(".md-typeset > :first-child",e);return h(t,"click",{once:!0}).pipe(l(()=>N(".md-typeset",e)),l(r=>({hash:__md_hash(r.innerHTML)})))}function nn(e){if(!te("announce.dismiss")||!e.childElementCount)return T;if(!e.hidden){let t=N(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return $(()=>{let t=new x;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),pa(e).pipe(w(r=>t.next(r)),k(()=>t.complete()),l(r=>I({ref:e},r)))})}function ma(e,{target$:t}){return t.pipe(l(r=>({hidden:r!==e})))}function an(e,t){let r=new x;return r.subscribe(({hidden:o})=>{e.hidden=o}),ma(e,t).pipe(w(o=>r.next(o)),k(()=>r.complete()),l(o=>I({ref:e},o)))}function la(e,t){let r=$(()=>Q([Uo(e),dt(t)])).pipe(l(([{x:o,y:n},i])=>{let{width:s,height:a}=he(e);return{x:o-i.x+s/2,y:n-i.y+a/2}}));return er(e).pipe(v(o=>r.pipe(l(n=>({active:o,offset:n})),ge(+!o||1/0))))}function sn(e,t,{target$:r}){let[o,n]=Array.from(e.children);return $(()=>{let i=new x,s=i.pipe(J(),ee(!0));return i.subscribe({next({offset:a}){e.style.setProperty("--md-tooltip-x",`${a.x}px`),e.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),nr(e).pipe(K(s)).subscribe(a=>{e.toggleAttribute("data-md-visible",a)}),M(i.pipe(L(({active:a})=>a)),i.pipe(ke(250),L(({active:a})=>!a))).subscribe({next({active:a}){a?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Ae(16,Te)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(Rr(125,Te),L(()=>!!e.offsetParent),l(()=>e.offsetParent.getBoundingClientRect()),l(({x:a})=>a)).subscribe({next(a){a?e.style.setProperty("--md-tooltip-0",`${-a}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),h(n,"click").pipe(K(s),L(a=>!(a.metaKey||a.ctrlKey))).subscribe(a=>{a.stopPropagation(),a.preventDefault()}),h(n,"mousedown").pipe(K(s),oe(i)).subscribe(([a,{active:c}])=>{var p;if(a.button!==0||a.metaKey||a.ctrlKey)a.preventDefault();else if(c){a.preventDefault();let m=e.parentElement.closest(".md-annotation");m instanceof HTMLElement?m.focus():(p=Re())==null||p.blur()}}),r.pipe(K(s),L(a=>a===o),ze(125)).subscribe(()=>e.focus()),la(e,t).pipe(w(a=>i.next(a)),k(()=>i.complete()),l(a=>I({ref:e},a)))})}function Wr(e){return O("div",{class:"md-tooltip",id:e},O("div",{class:"md-tooltip__inner md-typeset"}))}function cn(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return O("aside",{class:"md-annotation",tabIndex:0},Wr(t),O("a",{href:r,class:"md-annotation__index",tabIndex:-1},O("span",{"data-md-annotation-id":e})))}else return O("aside",{class:"md-annotation",tabIndex:0},Wr(t),O("span",{class:"md-annotation__index",tabIndex:-1},O("span",{"data-md-annotation-id":e})))}function pn(e){return O("button",{class:"md-clipboard md-icon",title:be("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function Ur(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(c=>!e.terms[c]).reduce((c,p)=>[...c,O("del",null,p)," "],[]).slice(0,-1),i=ue(),s=new URL(e.location,i.base);te("search.highlight")&&s.searchParams.set("h",Object.entries(e.terms).filter(([,c])=>c).reduce((c,[p])=>`${c} ${p}`.trim(),""));let{tags:a}=ue();return O("a",{href:`${s}`,class:"md-search-result__link",tabIndex:-1},O("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&O("div",{class:"md-search-result__icon md-icon"}),r>0&&O("h1",null,e.title),r<=0&&O("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(c=>{let p=a?c in a?`md-tag-icon md-tag--${a[c]}`:"md-tag-icon":"";return O("span",{class:`md-tag ${p}`},c)}),o>0&&n.length>0&&O("p",{class:"md-search-result__terms"},be("search.result.term.missing"),": ",...n)))}function mn(e){let t=e[0].score,r=[...e],o=ue(),n=r.findIndex(m=>!`${new URL(m.location,o.base)}`.includes("#")),[i]=r.splice(n,1),s=r.findIndex(m=>m.scoreUr(m,1)),...c.length?[O("details",{class:"md-search-result__more"},O("summary",{tabIndex:-1},O("div",null,c.length>0&&c.length===1?be("search.result.more.one"):be("search.result.more.other",c.length))),...c.map(m=>Ur(m,1)))]:[]];return O("li",{class:"md-search-result__item"},p)}function ln(e){return O("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>O("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?rr(r):r)))}function Nr(e){let t=`tabbed-control tabbed-control--${e}`;return O("div",{class:t,hidden:!0},O("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function fn(e){return O("div",{class:"md-typeset__scrollwrap"},O("div",{class:"md-typeset__table"},e))}function fa(e){let t=ue(),r=new URL(`../${e.version}/`,t.base);return O("li",{class:"md-version__item"},O("a",{href:`${r}`,class:"md-version__link"},e.title))}function un(e,t){return O("div",{class:"md-version"},O("button",{class:"md-version__current","aria-label":be("select.version")},t.title),O("ul",{class:"md-version__list"},e.map(fa)))}function ua(e){return e.tagName==="CODE"?z(".c, .c1, .cm",e):[e]}function da(e){let t=[];for(let r of ua(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let s;for(;s=/(\(\d+\))(!)?/.exec(i.textContent);){let[,a,c]=s;if(typeof c=="undefined"){let p=i.splitText(s.index);i=p.splitText(a.length),t.push(p)}else{i.textContent=a,t.push(i);break}}}}return t}function dn(e,t){t.append(...Array.from(e.childNodes))}function cr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,s=new Map;for(let a of da(t)){let[,c]=a.textContent.match(/\((\d+)\)/);ce(`:scope > li:nth-child(${c})`,e)&&(s.set(c,cn(c,i)),a.replaceWith(s.get(c)))}return s.size===0?T:$(()=>{let a=new x,c=a.pipe(J(),ee(!0)),p=[];for(let[m,f]of s)p.push([N(".md-typeset",f),N(`:scope > li:nth-child(${m})`,e)]);return o.pipe(K(c)).subscribe(m=>{e.hidden=!m,e.classList.toggle("md-annotation-list",m);for(let[f,u]of p)m?dn(f,u):dn(u,f)}),M(...[...s].map(([,m])=>sn(m,t,{target$:r}))).pipe(k(()=>a.complete()),le())})}function hn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return hn(t)}}function bn(e,t){return $(()=>{let r=hn(e);return typeof r!="undefined"?cr(r,e,t):T})}var gn=$t(Vr());var ha=0;function xn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return xn(t)}}function vn(e){return xe(e).pipe(l(({width:t})=>({scrollable:bt(e).width>t})),X("scrollable"))}function yn(e,t){let{matches:r}=matchMedia("(hover)"),o=$(()=>{let n=new x;if(n.subscribe(({scrollable:s})=>{s&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")}),gn.default.isSupported()&&(e.closest(".copy")||te("content.code.copy")&&!e.closest(".no-copy"))){let s=e.closest("pre");s.id=`__code_${ha++}`,s.insertBefore(pn(s.id),e)}let i=e.closest(".highlight");if(i instanceof HTMLElement){let s=xn(i);if(typeof s!="undefined"&&(i.classList.contains("annotate")||te("content.code.annotate"))){let a=cr(s,e,t);return vn(e).pipe(w(c=>n.next(c)),k(()=>n.complete()),l(c=>I({ref:e},c)),qe(xe(i).pipe(l(({width:c,height:p})=>c&&p),G(),v(c=>c?a:T))))}}return vn(e).pipe(w(s=>n.next(s)),k(()=>n.complete()),l(s=>I({ref:e},s)))});return te("content.lazy")?nr(e).pipe(L(n=>n),ge(1),v(()=>o)):o}function ba(e,{target$:t,print$:r}){let o=!0;return M(t.pipe(l(n=>n.closest("details:not([open])")),L(n=>e===n),l(()=>({action:"open",reveal:!0}))),r.pipe(L(n=>n||!o),w(()=>o=e.open),l(n=>({action:n?"open":"close"}))))}function En(e,t){return $(()=>{let r=new x;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),ba(e,t).pipe(w(o=>r.next(o)),k(()=>r.complete()),l(o=>I({ref:e},o)))})}var wn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var zr,ga=0;function xa(){return typeof mermaid=="undefined"||mermaid instanceof Element?ht("https://unpkg.com/mermaid@9.4.3/dist/mermaid.min.js"):H(void 0)}function Sn(e){return e.classList.remove("mermaid"),zr||(zr=xa().pipe(w(()=>mermaid.initialize({startOnLoad:!1,themeCSS:wn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),l(()=>{}),B(1))),zr.subscribe(()=>{e.classList.add("mermaid");let t=`__mermaid_${ga++}`,r=O("div",{class:"mermaid"}),o=e.textContent;mermaid.mermaidAPI.render(t,o,(n,i)=>{let s=r.attachShadow({mode:"closed"});s.innerHTML=n,e.replaceWith(r),i==null||i(s)})}),zr.pipe(l(()=>({ref:e})))}var Tn=O("table");function On(e){return e.replaceWith(Tn),Tn.replaceWith(fn(e)),H({ref:e})}function ya(e){let t=z(":scope > input",e),r=t.find(o=>o.checked)||t[0];return M(...t.map(o=>h(o,"change").pipe(l(()=>N(`label[for="${o.id}"]`))))).pipe(V(N(`label[for="${r.id}"]`)),l(o=>({active:o})))}function Mn(e,{viewport$:t}){let r=Nr("prev");e.append(r);let o=Nr("next");e.append(o);let n=N(".tabbed-labels",e);return $(()=>{let i=new x,s=i.pipe(J(),ee(!0));return Q([i,xe(e)]).pipe(Ae(1,Te),K(s)).subscribe({next([{active:a},c]){let p=Je(a),{width:m}=he(a);e.style.setProperty("--md-indicator-x",`${p.x}px`),e.style.setProperty("--md-indicator-width",`${m}px`);let f=tr(n);(p.xf.x+c.width)&&n.scrollTo({left:Math.max(0,p.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),Q([dt(n),xe(n)]).pipe(K(s)).subscribe(([a,c])=>{let p=bt(n);r.hidden=a.x<16,o.hidden=a.x>p.width-c.width-16}),M(h(r,"click").pipe(l(()=>-1)),h(o,"click").pipe(l(()=>1))).pipe(K(s)).subscribe(a=>{let{width:c}=he(n);n.scrollBy({left:c*a,behavior:"smooth"})}),te("content.tabs.link")&&i.pipe(je(1),oe(t)).subscribe(([{active:a},{offset:c}])=>{let p=a.innerText.trim();if(a.hasAttribute("data-md-switching"))a.removeAttribute("data-md-switching");else{let m=e.offsetTop-c.y;for(let u of z("[data-tabs]"))for(let d of z(":scope > input",u)){let b=N(`label[for="${d.id}"]`);if(b!==a&&b.innerText.trim()===p){b.setAttribute("data-md-switching",""),d.click();break}}window.scrollTo({top:e.offsetTop-m});let f=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([p,...f])])}}),i.pipe(K(s)).subscribe(()=>{for(let a of z("audio, video",e))a.pause()}),ya(e).pipe(w(a=>i.next(a)),k(()=>i.complete()),l(a=>I({ref:e},a)))}).pipe(rt(ae))}function Ln(e,{viewport$:t,target$:r,print$:o}){return M(...z(".annotate:not(.highlight)",e).map(n=>bn(n,{target$:r,print$:o})),...z("pre:not(.mermaid) > code",e).map(n=>yn(n,{target$:r,print$:o})),...z("pre.mermaid",e).map(n=>Sn(n)),...z("table:not([class])",e).map(n=>On(n)),...z("details",e).map(n=>En(n,{target$:r,print$:o})),...z("[data-tabs]",e).map(n=>Mn(n,{viewport$:t})))}function Ea(e,{alert$:t}){return t.pipe(v(r=>M(H(!0),H(!1).pipe(ze(2e3))).pipe(l(o=>({message:r,active:o})))))}function _n(e,t){let r=N(".md-typeset",e);return $(()=>{let o=new x;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),Ea(e,t).pipe(w(n=>o.next(n)),k(()=>o.complete()),l(n=>I({ref:e},n)))})}function wa({viewport$:e}){if(!te("header.autohide"))return H(!1);let t=e.pipe(l(({offset:{y:n}})=>n),Ce(2,1),l(([n,i])=>[nMath.abs(i-n.y)>100),l(([,[n]])=>n),G()),o=We("search");return Q([e,o]).pipe(l(([{offset:n},i])=>n.y>400&&!i),G(),v(n=>n?r:H(!1)),V(!1))}function An(e,t){return $(()=>Q([xe(e),wa(t)])).pipe(l(([{height:r},o])=>({height:r,hidden:o})),G((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function Cn(e,{header$:t,main$:r}){return $(()=>{let o=new x,n=o.pipe(J(),ee(!0));return o.pipe(X("active"),Ge(t)).subscribe(([{active:i},{hidden:s}])=>{e.classList.toggle("md-header--shadow",i&&!s),e.hidden=s}),r.subscribe(o),t.pipe(K(n),l(i=>I({ref:e},i)))})}function Sa(e,{viewport$:t,header$:r}){return sr(e,{viewport$:t,header$:r}).pipe(l(({offset:{y:o}})=>{let{height:n}=he(e);return{active:o>=n}}),X("active"))}function kn(e,t){return $(()=>{let r=new x;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=ce(".md-content h1");return typeof o=="undefined"?T:Sa(o,t).pipe(w(n=>r.next(n)),k(()=>r.complete()),l(n=>I({ref:e},n)))})}function Hn(e,{viewport$:t,header$:r}){let o=r.pipe(l(({height:i})=>i),G()),n=o.pipe(v(()=>xe(e).pipe(l(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),X("bottom"))));return Q([o,n,t]).pipe(l(([i,{top:s,bottom:a},{offset:{y:c},size:{height:p}}])=>(p=Math.max(0,p-Math.max(0,s-c,i)-Math.max(0,p+c-a)),{offset:s-i,height:p,active:s-i<=c})),G((i,s)=>i.offset===s.offset&&i.height===s.height&&i.active===s.active))}function Ta(e){let t=__md_get("__palette")||{index:e.findIndex(r=>matchMedia(r.getAttribute("data-md-color-media")).matches)};return H(...e).pipe(se(r=>h(r,"change").pipe(l(()=>r))),V(e[Math.max(0,t.index)]),l(r=>({index:e.indexOf(r),color:{scheme:r.getAttribute("data-md-color-scheme"),primary:r.getAttribute("data-md-color-primary"),accent:r.getAttribute("data-md-color-accent")}})),B(1))}function $n(e){let t=O("meta",{name:"theme-color"});document.head.appendChild(t);let r=O("meta",{name:"color-scheme"});return document.head.appendChild(r),$(()=>{let o=new x;o.subscribe(i=>{document.body.setAttribute("data-md-color-switching","");for(let[s,a]of Object.entries(i.color))document.body.setAttribute(`data-md-color-${s}`,a);for(let s=0;s{let i=ye("header"),s=window.getComputedStyle(i);return r.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(a=>(+a).toString(16).padStart(2,"0")).join("")})).subscribe(i=>t.content=`#${i}`),o.pipe(_e(ae)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")});let n=z("input",e);return Ta(n).pipe(w(i=>o.next(i)),k(()=>o.complete()),l(i=>I({ref:e},i)))})}var qr=$t(Vr());function Oa(e){e.setAttribute("data-md-copying","");let t=e.innerText;return e.removeAttribute("data-md-copying"),t}function Rn({alert$:e}){qr.default.isSupported()&&new j(t=>{new qr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Oa(N(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(w(t=>{t.trigger.focus()}),l(()=>be("clipboard.copied"))).subscribe(e)}function Ma(e){if(e.length<2)return[""];let[t,r]=[...e].sort((n,i)=>n.length-i.length).map(n=>n.replace(/[^/]+$/,"")),o=0;if(t===r)o=t.length;else for(;t.charCodeAt(o)===r.charCodeAt(o);)o++;return e.map(n=>n.replace(t.slice(0,o),""))}function pr(e){let t=__md_get("__sitemap",sessionStorage,e);if(t)return H(t);{let r=ue();return Jo(new URL("sitemap.xml",e||r.base)).pipe(l(o=>Ma(z("loc",o).map(n=>n.textContent))),pe(()=>T),He([]),w(o=>__md_set("__sitemap",o,sessionStorage,e)))}}function In({location$:e,viewport$:t}){let r=ue();if(location.protocol==="file:")return T;let o=pr().pipe(l(p=>p.map(m=>`${new URL(m,r.base)}`))),n=h(document.body,"click").pipe(oe(o),v(([p,m])=>{if(!(p.target instanceof Element))return T;let f=p.target.closest("a");if(f===null)return T;if(f.target||p.metaKey||p.ctrlKey)return T;let u=new URL(f.href);return u.search=u.hash="",m.includes(`${u}`)?(p.preventDefault(),H(new URL(f.href))):T}),le());n.pipe(ge(1)).subscribe(()=>{let p=ce("link[rel=icon]");typeof p!="undefined"&&(p.href=p.href)}),h(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),n.pipe(oe(t)).subscribe(([p,{offset:m}])=>{history.scrollRestoration="manual",history.replaceState(m,""),history.pushState(null,"",p)}),n.subscribe(e);let i=e.pipe(V(fe()),X("pathname"),je(1),v(p=>ar(p).pipe(pe(()=>(ot(p),T))))),s=new DOMParser,a=i.pipe(v(p=>p.text()),v(p=>{let m=s.parseFromString(p,"text/html");for(let u of["title","link[rel=canonical]","meta[name=author]","meta[name=description]","[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...te("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let d=ce(u),b=ce(u,m);typeof d!="undefined"&&typeof b!="undefined"&&d.replaceWith(b)}let f=ye("container");return Fe(z("script",f)).pipe(v(u=>{let d=m.createElement("script");if(u.src){for(let b of u.getAttributeNames())d.setAttribute(b,u.getAttribute(b));return u.replaceWith(d),new j(b=>{d.onload=()=>b.complete()})}else return d.textContent=u.textContent,u.replaceWith(d),T}),J(),ee(m))}),le());return h(window,"popstate").pipe(l(fe)).subscribe(e),e.pipe(V(fe()),Ce(2,1),v(([p,m])=>p.pathname===m.pathname&&p.hash!==m.hash?H(m):T)).subscribe(p=>{var m,f;history.state!==null||!p.hash?window.scrollTo(0,(f=(m=history.state)==null?void 0:m.y)!=null?f:0):(history.scrollRestoration="auto",Pr(p.hash),history.scrollRestoration="manual")}),a.pipe(oe(e)).subscribe(([,p])=>{var m,f;history.state!==null||!p.hash?window.scrollTo(0,(f=(m=history.state)==null?void 0:m.y)!=null?f:0):Pr(p.hash)}),a.pipe(v(()=>t),X("offset"),ke(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),a}var jn=$t(Fn());function Wn(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,s)=>`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return s=>(0,jn.default)(s).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Lt(e){return e.type===1}function mr(e){return e.type===3}function Un(e,t){let r=on(e);return M(H(location.protocol!=="file:"),We("search")).pipe($e(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:te("search.suggest")}}})),r}function Nn({document$:e}){let t=ue(),r=Ue(new URL("../versions.json",t.base)).pipe(pe(()=>T)),o=r.pipe(l(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:s,aliases:a})=>s===i||a.includes(i))||n[0]}));r.pipe(l(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>h(document.body,"click").pipe(L(i=>!i.metaKey&&!i.ctrlKey),oe(o),v(([i,s])=>{if(i.target instanceof Element){let a=i.target.closest("a");if(a&&!a.target&&n.has(a.href)){let c=a.href;return!i.target.closest(".md-version")&&n.get(c)===s?T:(i.preventDefault(),H(c))}}return T}),v(i=>{let{version:s}=n.get(i);return pr(new URL(i)).pipe(l(a=>{let p=fe().href.replace(t.base,"");return a.includes(p.split("#")[0])?new URL(`../${s}/${p}`,t.base):new URL(i)}))})))).subscribe(n=>ot(n)),Q([r,o]).subscribe(([n,i])=>{N(".md-header__topic").appendChild(un(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var s;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let a=((s=t.version)==null?void 0:s.default)||"latest";Array.isArray(a)||(a=[a]);e:for(let c of a)for(let p of n.aliases)if(new RegExp(c,"i").test(p)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let a of ne("outdated"))a.hidden=!1})}function ka(e,{worker$:t}){let{searchParams:r}=fe();r.has("q")&&(Ke("search",!0),e.value=r.get("q"),e.focus(),We("search").pipe($e(i=>!i)).subscribe(()=>{let i=new URL(location.href);i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=er(e),n=M(t.pipe($e(Lt)),h(e,"keyup"),o).pipe(l(()=>e.value),G());return Q([n,o]).pipe(l(([i,s])=>({value:i,focus:s})),B(1))}function Dn(e,{worker$:t}){let r=new x,o=r.pipe(J(),ee(!0));Q([t.pipe($e(Lt)),r],(i,s)=>s).pipe(X("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(X("focus")).subscribe(({focus:i})=>{i&&Ke("search",i)}),h(e.form,"reset").pipe(K(o)).subscribe(()=>e.focus());let n=N("header [for=__search]");return h(n,"click").subscribe(()=>e.focus()),ka(e,{worker$:t}).pipe(w(i=>r.next(i)),k(()=>r.complete()),l(i=>I({ref:e},i)),B(1))}function Vn(e,{worker$:t,query$:r}){let o=new x,n=zo(e.parentElement).pipe(L(Boolean)),i=e.parentElement,s=N(":scope > :first-child",e),a=N(":scope > :last-child",e);We("search").subscribe(m=>a.setAttribute("role",m?"list":"presentation")),o.pipe(oe(r),Hr(t.pipe($e(Lt)))).subscribe(([{items:m},{value:f}])=>{switch(m.length){case 0:s.textContent=f.length?be("search.result.none"):be("search.result.placeholder");break;case 1:s.textContent=be("search.result.one");break;default:let u=rr(m.length);s.textContent=be("search.result.other",u)}});let c=o.pipe(w(()=>a.innerHTML=""),v(({items:m})=>M(H(...m.slice(0,10)),H(...m.slice(10)).pipe(Ce(4),Ir(n),v(([f])=>f)))),l(mn),le());return c.subscribe(m=>a.appendChild(m)),c.pipe(se(m=>{let f=ce("details",m);return typeof f=="undefined"?T:h(f,"toggle").pipe(K(o),l(()=>f))})).subscribe(m=>{m.open===!1&&m.offsetTop<=i.scrollTop&&i.scrollTo({top:m.offsetTop})}),t.pipe(L(mr),l(({data:m})=>m)).pipe(w(m=>o.next(m)),k(()=>o.complete()),l(m=>I({ref:e},m)))}function Ha(e,{query$:t}){return t.pipe(l(({value:r})=>{let o=fe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function zn(e,t){let r=new x,o=r.pipe(J(),ee(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),h(e,"click").pipe(K(o)).subscribe(n=>n.preventDefault()),Ha(e,t).pipe(w(n=>r.next(n)),k(()=>r.complete()),l(n=>I({ref:e},n)))}function qn(e,{worker$:t,keyboard$:r}){let o=new x,n=ye("search-query"),i=M(h(n,"keydown"),h(n,"focus")).pipe(_e(ae),l(()=>n.value),G());return o.pipe(Ge(i),l(([{suggest:a},c])=>{let p=c.split(/([\s-]+)/);if(a!=null&&a.length&&p[p.length-1]){let m=a[a.length-1];m.startsWith(p[p.length-1])&&(p[p.length-1]=m)}else p.length=0;return p})).subscribe(a=>e.innerHTML=a.join("").replace(/\s/g," ")),r.pipe(L(({mode:a})=>a==="search")).subscribe(a=>{switch(a.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(L(mr),l(({data:a})=>a)).pipe(w(a=>o.next(a)),k(()=>o.complete()),l(()=>({ref:e})))}function Kn(e,{index$:t,keyboard$:r}){let o=ue();try{let n=Un(o.search,t),i=ye("search-query",e),s=ye("search-result",e);h(e,"click").pipe(L(({target:c})=>c instanceof Element&&!!c.closest("a"))).subscribe(()=>Ke("search",!1)),r.pipe(L(({mode:c})=>c==="search")).subscribe(c=>{let p=Re();switch(c.type){case"Enter":if(p===i){let m=new Map;for(let f of z(":first-child [href]",s)){let u=f.firstElementChild;m.set(f,parseFloat(u.getAttribute("data-md-score")))}if(m.size){let[[f]]=[...m].sort(([,u],[,d])=>d-u);f.click()}c.claim()}break;case"Escape":case"Tab":Ke("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof p=="undefined")i.focus();else{let m=[i,...z(":not(details) > [href], summary, details[open] [href]",s)],f=Math.max(0,(Math.max(0,m.indexOf(p))+m.length+(c.type==="ArrowUp"?-1:1))%m.length);m[f].focus()}c.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(L(({mode:c})=>c==="global")).subscribe(c=>{switch(c.type){case"f":case"s":case"/":i.focus(),i.select(),c.claim();break}});let a=Dn(i,{worker$:n});return M(a,Vn(s,{worker$:n,query$:a})).pipe(qe(...ne("search-share",e).map(c=>zn(c,{query$:a})),...ne("search-suggest",e).map(c=>qn(c,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ve}}function Qn(e,{index$:t,location$:r}){return Q([t,r.pipe(V(fe()),L(o=>!!o.searchParams.get("h")))]).pipe(l(([o,n])=>Wn(o.config)(n.searchParams.get("h"))),l(o=>{var s;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let a=i.nextNode();a;a=i.nextNode())if((s=a.parentElement)!=null&&s.offsetHeight){let c=a.textContent,p=o(c);p.length>c.length&&n.set(a,p)}for(let[a,c]of n){let{childNodes:p}=O("span",null,c);a.replaceWith(...Array.from(p))}return{ref:e,nodes:n}}))}function $a(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return Q([r,t]).pipe(l(([{offset:i,height:s},{offset:{y:a}}])=>(s=s+Math.min(n,Math.max(0,a-i))-n,{height:s,locked:a>=i+n})),G((i,s)=>i.height===s.height&&i.locked===s.locked))}function Kr(e,o){var n=o,{header$:t}=n,r=Zr(n,["header$"]);let i=N(".md-sidebar__scrollwrap",e),{y:s}=Je(i);return $(()=>{let a=new x,c=a.pipe(J(),ee(!0)),p=a.pipe(Ae(0,Te));return p.pipe(oe(t)).subscribe({next([{height:m},{height:f}]){i.style.height=`${m-2*s}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),p.pipe($e()).subscribe(()=>{for(let m of z(".md-nav__link--active[href]",e)){let f=or(m);if(typeof f!="undefined"){let u=m.offsetTop-f.offsetTop,{height:d}=he(f);f.scrollTo({top:u-d/2})}}}),me(z("label[tabindex]",e)).pipe(se(m=>h(m,"click").pipe(l(()=>m),K(c)))).subscribe(m=>{let f=N(`[id="${m.htmlFor}"]`);N(`[aria-labelledby="${m.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),$a(e,r).pipe(w(m=>a.next(m)),k(()=>a.complete()),l(m=>I({ref:e},m)))})}function Yn(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Tt(Ue(`${r}/releases/latest`).pipe(pe(()=>T),l(o=>({version:o.tag_name})),He({})),Ue(r).pipe(pe(()=>T),l(o=>({stars:o.stargazers_count,forks:o.forks_count})),He({}))).pipe(l(([o,n])=>I(I({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ue(r).pipe(l(o=>({repositories:o.public_repos})),He({}))}}function Bn(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ue(r).pipe(pe(()=>T),l(({star_count:o,forks_count:n})=>({stars:o,forks:n})),He({}))}function Gn(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return Yn(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return Bn(r,o)}return T}var Ra;function Ia(e){return Ra||(Ra=$(()=>{let t=__md_get("__source",sessionStorage);if(t)return H(t);if(ne("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return T}return Gn(e.href).pipe(w(o=>__md_set("__source",o,sessionStorage)))}).pipe(pe(()=>T),L(t=>Object.keys(t).length>0),l(t=>({facts:t})),B(1)))}function Jn(e){let t=N(":scope > :last-child",e);return $(()=>{let r=new x;return r.subscribe(({facts:o})=>{t.appendChild(ln(o)),t.classList.add("md-source__repository--active")}),Ia(e).pipe(w(o=>r.next(o)),k(()=>r.complete()),l(o=>I({ref:e},o)))})}function Pa(e,{viewport$:t,header$:r}){return xe(document.body).pipe(v(()=>sr(e,{header$:r,viewport$:t})),l(({offset:{y:o}})=>({hidden:o>=10})),X("hidden"))}function Xn(e,t){return $(()=>{let r=new x;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(te("navigation.tabs.sticky")?H({hidden:!1}):Pa(e,t)).pipe(w(o=>r.next(o)),k(()=>r.complete()),l(o=>I({ref:e},o)))})}function Fa(e,{viewport$:t,header$:r}){let o=new Map,n=z("[href^=\\#]",e);for(let a of n){let c=decodeURIComponent(a.hash.substring(1)),p=ce(`[id="${c}"]`);typeof p!="undefined"&&o.set(a,p)}let i=r.pipe(X("height"),l(({height:a})=>{let c=ye("main"),p=N(":scope > :first-child",c);return a+.8*(p.offsetTop-c.offsetTop)}),le());return xe(document.body).pipe(X("height"),v(a=>$(()=>{let c=[];return H([...o].reduce((p,[m,f])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=f.tagName;)c.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let d=f.offsetParent;for(;d;d=d.offsetParent)u+=d.offsetTop;return p.set([...c=[...c,m]].reverse(),u)},new Map))}).pipe(l(c=>new Map([...c].sort(([,p],[,m])=>p-m))),Ge(i),v(([c,p])=>t.pipe(Cr(([m,f],{offset:{y:u},size:d})=>{let b=u+d.height>=Math.floor(a.height);for(;f.length;){let[,_]=f[0];if(_-p=u&&!b)f=[m.pop(),...f];else break}return[m,f]},[[],[...c]]),G((m,f)=>m[0]===f[0]&&m[1]===f[1])))))).pipe(l(([a,c])=>({prev:a.map(([p])=>p),next:c.map(([p])=>p)})),V({prev:[],next:[]}),Ce(2,1),l(([a,c])=>a.prev.length{let i=new x,s=i.pipe(J(),ee(!0));if(i.subscribe(({prev:a,next:c})=>{for(let[p]of c)p.classList.remove("md-nav__link--passed"),p.classList.remove("md-nav__link--active");for(let[p,[m]]of a.entries())m.classList.add("md-nav__link--passed"),m.classList.toggle("md-nav__link--active",p===a.length-1)}),te("toc.follow")){let a=M(t.pipe(ke(1),l(()=>{})),t.pipe(ke(250),l(()=>"smooth")));i.pipe(L(({prev:c})=>c.length>0),Ge(o.pipe(_e(ae))),oe(a)).subscribe(([[{prev:c}],p])=>{let[m]=c[c.length-1];if(m.offsetHeight){let f=or(m);if(typeof f!="undefined"){let u=m.offsetTop-f.offsetTop,{height:d}=he(f);f.scrollTo({top:u-d/2,behavior:p})}}})}return te("navigation.tracking")&&t.pipe(K(s),X("offset"),ke(250),je(1),K(n.pipe(je(1))),Ot({delay:250}),oe(i)).subscribe(([,{prev:a}])=>{let c=fe(),p=a[a.length-1];if(p&&p.length){let[m]=p,{hash:f}=new URL(m.href);c.hash!==f&&(c.hash=f,history.replaceState({},"",`${c}`))}else c.hash="",history.replaceState({},"",`${c}`)}),Fa(e,{viewport$:t,header$:r}).pipe(w(a=>i.next(a)),k(()=>i.complete()),l(a=>I({ref:e},a)))})}function ja(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(l(({offset:{y:s}})=>s),Ce(2,1),l(([s,a])=>s>a&&a>0),G()),i=r.pipe(l(({active:s})=>s));return Q([i,n]).pipe(l(([s,a])=>!(s&&a)),G(),K(o.pipe(je(1))),ee(!0),Ot({delay:250}),l(s=>({hidden:s})))}function ei(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new x,s=i.pipe(J(),ee(!0));return i.subscribe({next({hidden:a}){e.hidden=a,a?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(K(s),X("height")).subscribe(({height:a})=>{e.style.top=`${a+16}px`}),h(e,"click").subscribe(a=>{a.preventDefault(),window.scrollTo({top:0})}),ja(e,{viewport$:t,main$:o,target$:n}).pipe(w(a=>i.next(a)),k(()=>i.complete()),l(a=>I({ref:e},a)))}function ti({document$:e,tablet$:t}){e.pipe(v(()=>z(".md-toggle--indeterminate")),w(r=>{r.indeterminate=!0,r.checked=!1}),se(r=>h(r,"change").pipe($r(()=>r.classList.contains("md-toggle--indeterminate")),l(()=>r))),oe(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function Wa(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function ri({document$:e}){e.pipe(v(()=>z("[data-md-scrollfix]")),w(t=>t.removeAttribute("data-md-scrollfix")),L(Wa),se(t=>h(t,"touchstart").pipe(l(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function oi({viewport$:e,tablet$:t}){Q([We("search"),t]).pipe(l(([r,o])=>r&&!o),v(r=>H(r).pipe(ze(r?400:100))),oe(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function Ua(){return location.protocol==="file:"?ht(`${new URL("search/search_index.js",Qr.base)}`).pipe(l(()=>__index),B(1)):Ue(new URL("search/search_index.json",Qr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var nt=Wo(),At=Qo(),gt=Bo(At),Yr=Ko(),Se=rn(),lr=Fr("(min-width: 960px)"),ii=Fr("(min-width: 1220px)"),ai=Go(),Qr=ue(),si=document.forms.namedItem("search")?Ua():Ve,Br=new x;Rn({alert$:Br});te("navigation.instant")&&In({location$:At,viewport$:Se}).subscribe(nt);var ni;((ni=Qr.version)==null?void 0:ni.provider)==="mike"&&Nn({document$:nt});M(At,gt).pipe(ze(125)).subscribe(()=>{Ke("drawer",!1),Ke("search",!1)});Yr.pipe(L(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=ce("link[rel=prev]");typeof t!="undefined"&&ot(t);break;case"n":case".":let r=ce("link[rel=next]");typeof r!="undefined"&&ot(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});ti({document$:nt,tablet$:lr});ri({document$:nt});oi({viewport$:Se,tablet$:lr});var Xe=An(ye("header"),{viewport$:Se}),_t=nt.pipe(l(()=>ye("main")),v(e=>Hn(e,{viewport$:Se,header$:Xe})),B(1)),Na=M(...ne("consent").map(e=>an(e,{target$:gt})),...ne("dialog").map(e=>_n(e,{alert$:Br})),...ne("header").map(e=>Cn(e,{viewport$:Se,header$:Xe,main$:_t})),...ne("palette").map(e=>$n(e)),...ne("search").map(e=>Kn(e,{index$:si,keyboard$:Yr})),...ne("source").map(e=>Jn(e))),Da=$(()=>M(...ne("announce").map(e=>nn(e)),...ne("content").map(e=>Ln(e,{viewport$:Se,target$:gt,print$:ai})),...ne("content").map(e=>te("search.highlight")?Qn(e,{index$:si,location$:At}):T),...ne("header-title").map(e=>kn(e,{viewport$:Se,header$:Xe})),...ne("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?jr(ii,()=>Kr(e,{viewport$:Se,header$:Xe,main$:_t})):jr(lr,()=>Kr(e,{viewport$:Se,header$:Xe,main$:_t}))),...ne("tabs").map(e=>Xn(e,{viewport$:Se,header$:Xe})),...ne("toc").map(e=>Zn(e,{viewport$:Se,header$:Xe,main$:_t,target$:gt})),...ne("top").map(e=>ei(e,{viewport$:Se,header$:Xe,main$:_t,target$:gt})))),ci=nt.pipe(v(()=>Da),qe(Na),B(1));ci.subscribe();window.document$=nt;window.location$=At;window.target$=gt;window.keyboard$=Yr;window.viewport$=Se;window.tablet$=lr;window.screen$=ii;window.print$=ai;window.alert$=Br;window.component$=ci;})();
+//# sourceMappingURL=bundle.dff1b7c8.min.js.map
+
diff --git a/assets/javascripts/bundle.dff1b7c8.min.js.map b/assets/javascripts/bundle.dff1b7c8.min.js.map
new file mode 100755
index 00000000..82d90238
--- /dev/null
+++ b/assets/javascripts/bundle.dff1b7c8.min.js.map
@@ -0,0 +1,8 @@
+{
+ "version": 3,
+ "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/assets/javascripts/browser/document/index.ts", "src/assets/javascripts/browser/element/_/index.ts", "src/assets/javascripts/browser/element/focus/index.ts", "src/assets/javascripts/browser/element/offset/_/index.ts", "src/assets/javascripts/browser/element/offset/content/index.ts", "src/assets/javascripts/utilities/h/index.ts", "src/assets/javascripts/utilities/round/index.ts", "src/assets/javascripts/browser/script/index.ts", "src/assets/javascripts/browser/element/size/_/index.ts", "src/assets/javascripts/browser/element/size/content/index.ts", "src/assets/javascripts/browser/element/visibility/index.ts", "src/assets/javascripts/browser/toggle/index.ts", "src/assets/javascripts/browser/keyboard/index.ts", "src/assets/javascripts/browser/location/_/index.ts", "src/assets/javascripts/browser/location/hash/index.ts", "src/assets/javascripts/browser/media/index.ts", "src/assets/javascripts/browser/request/index.ts", "src/assets/javascripts/browser/viewport/offset/index.ts", "src/assets/javascripts/browser/viewport/size/index.ts", "src/assets/javascripts/browser/viewport/_/index.ts", "src/assets/javascripts/browser/viewport/at/index.ts", "src/assets/javascripts/browser/worker/index.ts", "src/assets/javascripts/_/index.ts", "src/assets/javascripts/components/_/index.ts", "src/assets/javascripts/components/announce/index.ts", "src/assets/javascripts/components/consent/index.ts", "src/assets/javascripts/components/content/annotation/_/index.ts", "src/assets/javascripts/templates/tooltip/index.tsx", "src/assets/javascripts/templates/annotation/index.tsx", "src/assets/javascripts/templates/clipboard/index.tsx", "src/assets/javascripts/templates/search/index.tsx", "src/assets/javascripts/templates/source/index.tsx", "src/assets/javascripts/templates/tabbed/index.tsx", "src/assets/javascripts/templates/table/index.tsx", "src/assets/javascripts/templates/version/index.tsx", "src/assets/javascripts/components/content/annotation/list/index.ts", "src/assets/javascripts/components/content/annotation/block/index.ts", "src/assets/javascripts/components/content/code/_/index.ts", "src/assets/javascripts/components/content/details/index.ts", "src/assets/javascripts/components/content/mermaid/index.css", "src/assets/javascripts/components/content/mermaid/index.ts", "src/assets/javascripts/components/content/table/index.ts", "src/assets/javascripts/components/content/tabs/index.ts", "src/assets/javascripts/components/content/_/index.ts", "src/assets/javascripts/components/dialog/index.ts", "src/assets/javascripts/components/header/_/index.ts", "src/assets/javascripts/components/header/title/index.ts", "src/assets/javascripts/components/main/index.ts", "src/assets/javascripts/components/palette/index.ts", "src/assets/javascripts/integrations/clipboard/index.ts", "src/assets/javascripts/integrations/sitemap/index.ts", "src/assets/javascripts/integrations/instant/index.ts", "src/assets/javascripts/integrations/search/highlighter/index.ts", "src/assets/javascripts/integrations/search/worker/message/index.ts", "src/assets/javascripts/integrations/search/worker/_/index.ts", "src/assets/javascripts/integrations/version/index.ts", "src/assets/javascripts/components/search/query/index.ts", "src/assets/javascripts/components/search/result/index.ts", "src/assets/javascripts/components/search/share/index.ts", "src/assets/javascripts/components/search/suggest/index.ts", "src/assets/javascripts/components/search/_/index.ts", "src/assets/javascripts/components/search/highlight/index.ts", "src/assets/javascripts/components/sidebar/index.ts", "src/assets/javascripts/components/source/facts/github/index.ts", "src/assets/javascripts/components/source/facts/gitlab/index.ts", "src/assets/javascripts/components/source/facts/_/index.ts", "src/assets/javascripts/components/source/_/index.ts", "src/assets/javascripts/components/tabs/index.ts", "src/assets/javascripts/components/toc/index.ts", "src/assets/javascripts/components/top/index.ts", "src/assets/javascripts/patches/indeterminate/index.ts", "src/assets/javascripts/patches/scrollfix/index.ts", "src/assets/javascripts/patches/scrolllock/index.ts", "src/assets/javascripts/polyfills/index.ts"],
+ "sourceRoot": "../../..",
+ "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2023 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantLoading,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up instant loading, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantLoading({ location$, viewport$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver