Enumerations |
Functions | |||||||||
| void | gosling_context_set_tor_bootstrap_status_received_callback (gosling_context *context, gosling_tor_bootstrap_status_received_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_tor_bootstrap_completed_callback (gosling_context *context, gosling_tor_bootstrap_completed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_tor_log_received_callback (gosling_context *context, gosling_tor_log_received_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_challenge_response_size_callback (gosling_context *context, gosling_identity_client_handshake_challenge_response_size_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_build_challenge_response_callback (gosling_context *context, gosling_identity_client_handshake_build_challenge_response_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_handshake_completed_callback (gosling_context *context, gosling_identity_client_handshake_completed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_handshake_failed_callback (gosling_context *context, gosling_identity_client_handshake_failed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_published_callback (gosling_context *context, gosling_identity_server_published_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_started_callback (gosling_context *context, gosling_identity_server_handshake_started_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_client_allowed_callback (gosling_context *context, gosling_identity_server_handshake_client_allowed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_endpoint_supported_callback (gosling_context *context, gosling_identity_server_endpoint_supported_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_challenge_size_callback (gosling_context *context, gosling_identity_server_handshake_challenge_size_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_build_challenge_callback (gosling_context *context, gosling_identity_server_handshake_build_challenge_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_verify_challenge_response_callback (gosling_context *context, gosling_identity_server_handshake_verify_challenge_response_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_completed_callback (gosling_context *context, gosling_identity_server_handshake_completed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_rejected_callback (gosling_context *context, gosling_identity_server_handshake_rejected_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_failed_callback (gosling_context *context, gosling_identity_server_handshake_failed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_client_handshake_completed_callback (gosling_context *context, gosling_endpoint_client_handshake_completed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_client_handshake_failed_callback (gosling_context *context, gosling_endpoint_client_handshake_failed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_published_callback (gosling_context *context, gosling_endpoint_server_published_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_started_callback (gosling_context *context, gosling_endpoint_server_handshake_started_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_channel_supported_callback (gosling_context *context, gosling_endpoint_server_channel_supported_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_completed_callback (gosling_context *context, gosling_endpoint_server_handshake_completed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_rejected_callback (gosling_context *context, gosling_endpoint_server_handshake_rejected_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_failed_callback (gosling_context *context, gosling_endpoint_server_handshake_failed_callback_t callback, gosling_error **error) | ||||||||
| void | gosling_context_set_tor_bootstrap_status_received_callback (gosling_context *context, gosling_tor_bootstrap_status_received_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_tor_bootstrap_completed_callback (gosling_context *context, gosling_tor_bootstrap_completed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_tor_log_received_callback (gosling_context *context, gosling_tor_log_received_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_challenge_response_size_callback (gosling_context *context, gosling_identity_client_handshake_challenge_response_size_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_build_challenge_response_callback (gosling_context *context, gosling_identity_client_handshake_build_challenge_response_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_handshake_completed_callback (gosling_context *context, gosling_identity_client_handshake_completed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_client_handshake_failed_callback (gosling_context *context, gosling_identity_client_handshake_failed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_published_callback (gosling_context *context, gosling_identity_server_published_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_started_callback (gosling_context *context, gosling_identity_server_handshake_started_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_client_allowed_callback (gosling_context *context, gosling_identity_server_handshake_client_allowed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_endpoint_supported_callback (gosling_context *context, gosling_identity_server_endpoint_supported_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_challenge_size_callback (gosling_context *context, gosling_identity_server_handshake_challenge_size_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_build_challenge_callback (gosling_context *context, gosling_identity_server_handshake_build_challenge_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_verify_challenge_response_callback (gosling_context *context, gosling_identity_server_handshake_verify_challenge_response_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_completed_callback (gosling_context *context, gosling_identity_server_handshake_completed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_rejected_callback (gosling_context *context, gosling_identity_server_handshake_rejected_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_identity_server_handshake_failed_callback (gosling_context *context, gosling_identity_server_handshake_failed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_client_handshake_completed_callback (gosling_context *context, gosling_endpoint_client_handshake_completed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_client_handshake_failed_callback (gosling_context *context, gosling_endpoint_client_handshake_failed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_published_callback (gosling_context *context, gosling_endpoint_server_published_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_started_callback (gosling_context *context, gosling_endpoint_server_handshake_started_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_channel_supported_callback (gosling_context *context, gosling_endpoint_server_channel_supported_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_completed_callback (gosling_context *context, gosling_endpoint_server_handshake_completed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_rejected_callback (gosling_context *context, gosling_endpoint_server_handshake_rejected_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_set_endpoint_server_handshake_failed_callback (gosling_context *context, gosling_endpoint_server_handshake_failed_callback_t callback, void *callback_data, gosling_error **error) | ||||||||
| void | gosling_context_free (gosling_context *in_context) | ||||||||
| void | gosling_context_init (gosling_context **out_context, gosling_tor_provider *in_tor_provider, uint16_t identity_port, uint16_t endpoint_port, const gosling_ed25519_private_key *identity_private_key, gosling_error **error) | ||||||||
| typedef void(* gosling_endpoint_client_handshake_completed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *endpoint_service_id, const char *channel_name, size_t channel_name_length, gosling_tcp_socket_t stream) | +typedef void(* gosling_endpoint_client_handshake_completed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *endpoint_service_id, const char *channel_name, size_t channel_name_length, gosling_tcp_socket_t stream) |
The function pointer type for the endpoint client handshake completed callback. This callback is called when the client successfully connects to an endpoint server.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| endpoint_service_id | the onion service id of the endpoint server the client has connected to |
| typedef void(* gosling_endpoint_client_handshake_failed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) | +typedef void(* gosling_endpoint_client_handshake_failed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) |
The function pointer type for the endpoint client handshake handshake failed callback. This callback is called when a client's endpoint handshake fails.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| error | error associated with this failure |
| typedef bool(* gosling_endpoint_server_channel_supported_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *client_service_id, const char *channel_name, size_t channel_name_length) | +typedef bool(* gosling_endpoint_server_channel_supported_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *client_service_id, const char *channel_name, size_t channel_name_length) |
The function pointer type of the endpoint server channel supported callback. This callback is called when the server needs to determine if the client's requested channel is supported. The result of this callback partially determines if an incoming endpoint client handshake request is possible to complete.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| client_service_id | the onion service id of the connected endpoint client |
| typedef void(* gosling_endpoint_server_handshake_completed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *endpoint_service_id, const gosling_v3_onion_service_id *client_service_id, const char *channel_name, size_t channel_name_length, gosling_tcp_socket_t stream) | +typedef void(* gosling_endpoint_server_handshake_completed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *endpoint_service_id, const gosling_v3_onion_service_id *client_service_id, const char *channel_name, size_t channel_name_length, gosling_tcp_socket_t stream) |
The function pointer type for the endpoint server handshake completed callback. This callback is called when an endpoint server completes a handshake with an endpoint client.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| endpoint_service_id | the onion service id of the endpoint server the endpoint client has connected to |
| typedef void(* gosling_endpoint_server_handshake_failed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) | +typedef void(* gosling_endpoint_server_handshake_failed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) |
The function pointer type for the endpoint server handshake handshake failed callback. This callback is called when a server's endpoint handshake fails.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| error | error associated with this failure |
| typedef void(* gosling_endpoint_server_handshake_rejected_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, bool client_allowed, bool client_requested_channel_valid, bool client_proof_signature_valid) | +typedef void(* gosling_endpoint_server_handshake_rejected_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, bool client_allowed, bool client_requested_channel_valid, bool client_proof_signature_valid) |
The function pointer type of the endpoint server handshake rejected callback. This callback is called whenever the endpoint server has rejected an endpoint client's handshake.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| client_allowed | true if requesting client is allowed, false otherwies |
| typedef void(* gosling_endpoint_server_handshake_started_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle) | +typedef void(* gosling_endpoint_server_handshake_started_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle) |
The function pointer type of the endpoint server handshake started callback. This callback is called whenever the endpoint server is initially connected to.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback |
| context | the context associated with this event |
| handshake_handle | the handshake handle this callback is associated with |
| typedef void(* gosling_endpoint_server_published_callback_t) (gosling_context *context, const gosling_v3_onion_service_id *endpoint_service_id, const char *endpoint_name, size_t endpoint_name_length) | +typedef void(* gosling_endpoint_server_published_callback_t) (void *callback_data, gosling_context *context, const gosling_v3_onion_service_id *endpoint_service_id, const char *endpoint_name, size_t endpoint_name_length) |
The function pointer type for the endpoint server published callback. This callbcak is called whenever the onion service of the indicated endpoint server associted with the given context is published and should be reachable by clients.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| endpoint_service_id | the onion service id of the published endpoint server | ||||||||
| endpoint_name | the null-terminated name of the endpoint server published |
| typedef void(* gosling_identity_client_handshake_build_challenge_response_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_buffer, size_t challenge_buffer_size, uint8_t *out_challenge_response_buffer, size_t out_challenge_response_buffer_size) | +typedef void(* gosling_identity_client_handshake_build_challenge_response_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_buffer, size_t challenge_buffer_size, uint8_t *out_challenge_response_buffer, size_t out_challenge_response_buffer_size) |
The function pointer type for the identity client handshake build challlenge response callback. This callback is called when a client is ready to build a challenge response object.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| challenge_buffer | the source buffer containing a BSON document received from the identity server to serve as an endpoint request challenge |
| typedef size_t(* gosling_identity_client_handshake_challenge_response_size_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_buffer, size_t challenge_buffer_size) | +typedef size_t(* gosling_identity_client_handshake_challenge_response_size_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_buffer, size_t challenge_buffer_size) |
The function pointer type for the client handshake challenge response size callback. This callback is called when a client needs to know how much memory to allocate for a challenge response.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | pointer to the client handshake handle this callback invocation is associated with; null if no client handshake init callback was provided | ||||||||
| challenge_buffer | the source buffer containing a BSON document received from the identity server to serve as an endpoint request challenge |
| typedef void(* gosling_identity_client_handshake_completed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *identity_service_id, const gosling_v3_onion_service_id *endpoint_service_id, const char *endpoint_name, size_t endpoint_name_length, const gosling_x25519_private_key *client_auth_private_key) | +typedef void(* gosling_identity_client_handshake_completed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *identity_service_id, const gosling_v3_onion_service_id *endpoint_service_id, const char *endpoint_name, size_t endpoint_name_length, const gosling_x25519_private_key *client_auth_private_key) |
The function pointer type for the identity client handshake completed callback. This callback is called whenever the client successfully completes a handshake with an identity server and is granted access to an endpoint server.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| identity_service_id | the onion service id of the identity server the client has successfully completed a hadshake with |
| typedef void(* gosling_identity_client_handshake_failed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) | +typedef void(* gosling_identity_client_handshake_failed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) |
The function pointer type for the identity client handshake handshake failed callback. This callback is called when a client's identity handshake fails.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| error | error associated with this failure |
| typedef bool(* gosling_identity_server_endpoint_supported_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const char *endpoint_name, size_t endpoint_name_length) | +typedef bool(* gosling_identity_server_endpoint_supported_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const char *endpoint_name, size_t endpoint_name_length) |
The function pointer type of the identity server endpoint supported callback. This callback is called when the server needs to determine if the client's requested endpoint is supported. The result of this callback partially determines if an incoming client handshake request is possible to complete.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| endpoint_name | a null-terminated ASCII string containing the name of the endpoint being requested |
| typedef void(* gosling_identity_server_handshake_build_challenge_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, uint8_t *out_challenge_buffer, size_t out_challenge_buffer_size) | +typedef void(* gosling_identity_server_handshake_build_challenge_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, uint8_t *out_challenge_buffer, size_t out_challenge_buffer_size) |
The function pointer type for the server handshake build challenge callback. This callback is called when a server needs to build a challenge object.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| out_challenge_buffer | the destination buffer for the callback to write a BSON document representing the endpoint request challenge object |
| typedef size_t(* gosling_identity_server_handshake_challenge_size_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle) | +typedef size_t(* gosling_identity_server_handshake_challenge_size_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle) |
The function pointer type for the server handshake challenge size callback. This callback is called when a server needs to know how much memory to allocate for a challenge.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback |
| context | the context associated with this event |
| handshake_handle | the handshake handle this callback is associated with |
| typedef bool(* gosling_identity_server_handshake_client_allowed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *client_service_id) | +typedef bool(* gosling_identity_server_handshake_client_allowed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_v3_onion_service_id *client_service_id) |
The function pointer type of the identity server handshake client allowed callback. The result of this callback partially determines if an incoming client handshake request is possible to complete. For instance an implementation of this function completed.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| client_service_id | the v3 onion service id of the connected client |
| typedef void(* gosling_identity_server_handshake_completed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_ed25519_private_key *endpoint_private_key, const char *endpoint_name, size_t endpoint_name_length, const gosling_v3_onion_service_id *client_service_id, const gosling_x25519_public_key *client_auth_public_key) | +typedef void(* gosling_identity_server_handshake_completed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_ed25519_private_key *endpoint_private_key, const char *endpoint_name, size_t endpoint_name_length, const gosling_v3_onion_service_id *client_service_id, const gosling_x25519_public_key *client_auth_public_key) |
The function pointer type for the identity server handshake completed callback. This callback is called whenever the identity server has successfully completed a handshake with and granted to a connecting identity client.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| endpoint_private_key | the ed25519 private key of the endpoint server to host for the client |
| typedef void(* gosling_identity_server_handshake_failed_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) | +typedef void(* gosling_identity_server_handshake_failed_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const gosling_error *error) |
The function pointer type for the identity server handshake handshake failed callback. This callback is called when a server's identity handshake fails.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| error | error associated with this failure |
| typedef void(* gosling_identity_server_handshake_rejected_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, bool client_allowed, bool client_requested_endpoint_valid, bool client_proof_signature_valid, bool client_auth_signature_valid, bool challenge_response_valid) | +typedef void(* gosling_identity_server_handshake_rejected_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, bool client_allowed, bool client_requested_endpoint_valid, bool client_proof_signature_valid, bool client_auth_signature_valid, bool challenge_response_valid) |
The function pointer type of the identity server handshake rejected callback. This callback is called whenever the identity server has rejected an identity client's handshake.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| client_allowed | true if requesting client is allowed, false otherwies |
| typedef void(* gosling_identity_server_handshake_started_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle) | +typedef void(* gosling_identity_server_handshake_started_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle) |
The function pointer type of the identity server handshake started callback. This callback is called whenever the identity server is initially connected to.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback |
| context | the context associated with this event |
| handshake_handle | the handshake handle this callback is associated with |
| typedef bool(* gosling_identity_server_handshake_verify_challenge_response_callback_t) (gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_response_buffer, size_t challenge_response_buffer_size) | +typedef bool(* gosling_identity_server_handshake_verify_challenge_response_callback_t) (void *callback_data, gosling_context *context, gosling_handshake_handle_t handshake_handle, const uint8_t *challenge_response_buffer, size_t challenge_response_buffer_size) |
The function poointer type for the server handshake verify challenge response callback. This callback is called when a server needs to verify a challenge response object.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| handshake_handle | the handshake handle this callback is associated with | ||||||||
| challenge_response_buffer | a buffer containing the BSON document representing the endpoint request challenge response object |
| typedef void(* gosling_identity_server_published_callback_t) (gosling_context *context) | +typedef void(* gosling_identity_server_published_callback_t) (void *callback_data, gosling_context *context) |
The function pointer type for the identity server published callback. This callback is called whenever the onion service of the identity server associated with the given context is published and should be reachable by clients.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback |
| context | the context associated with this event |
| typedef void(* gosling_tor_bootstrap_completed_callback_t) (gosling_context *context) | +typedef void(* gosling_tor_bootstrap_completed_callback_t) (void *callback_data, gosling_context *context) |
The function pointer type for the tor boootstrap completed callback. This callback is called when the context's tor daemon's bootstrap process has completed.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback |
| context | the context associated with this event |
| typedef void(* gosling_tor_bootstrap_status_received_callback_t) (gosling_context *context, uint32_t progress, const char *tag, size_t tag_length, const char *summary, size_t summary_length) | +typedef void(* gosling_tor_bootstrap_status_received_callback_t) (void *callback_data, gosling_context *context, uint32_t progress, const char *tag, size_t tag_length, const char *summary, size_t summary_length) |
The function pointer type for the tor bootstrap status received callback. This callback is called when context's tor daemon's bootstrap status has progressed.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| progress | an unsigned integer from 0 to 100 indicating the current completion perentage of the context's bootstrap process | ||||||||
| tag | the null-terminated short name of the current bootstrap stage |
| typedef void(* gosling_tor_log_received_callback_t) (gosling_context *context, const char *line, size_t line_length) | +typedef void(* gosling_tor_log_received_callback_t) (void *callback_data, gosling_context *context, const char *line, size_t line_length) |
The function pointer type for the tor log received callback. This callback is called whenever the context's tor daemon prints new log lines.
| callback_data | arbitrary pointer to developer-defined memory provided when setting this callback | ||||||||
| context | the context associated with this event | ||||||||
| line | the null-terminated received log line | ||||||||
| line_length | the number of chars in line not including the null-terminator | - | gosling_endpoint_client_handshake_completed_callback_t | +gosling_endpoint_client_handshake_completed_callback_t | callback, | +||||
| + | + | void * | +callback_data, | +||||||
| @@ -2153,6 +2184,7 @@ | |||||||||
| context | the context to register the callback to | ||||||||
| callback | the callback to register | ||||||||
| callback_data | the custom data to pass to this callback | ||||||||
| error | filled on error |
pub enum ContextEvent {
+ContextEvent in gosling::context - Rust Enum gosling::context::ContextEvent
source · pub enum ContextEvent {
Show 21 variants
TorBootstrapStatusReceived {
- progress: u32,
- tag: String,
- summary: String,
+ progress: u32,
+ tag: String,
+ summary: String,
},
TorBootstrapCompleted,
TorLogReceived {
- line: String,
+ line: String,
},
IdentityClientChallengeReceived {
handle: HandshakeHandle,
@@ -16,7 +16,7 @@
handle: HandshakeHandle,
identity_service_id: V3OnionServiceId,
endpoint_service_id: V3OnionServiceId,
- endpoint_name: String,
+ endpoint_name: String,
client_auth_private_key: X25519PrivateKey,
},
IdentityClientHandshakeFailed {
@@ -30,7 +30,7 @@
IdentityServerEndpointRequestReceived {
handle: HandshakeHandle,
client_service_id: V3OnionServiceId,
- requested_endpoint: String,
+ requested_endpoint: String,
},
IdentityServerChallengeResponseReceived {
handle: HandshakeHandle,
@@ -39,17 +39,17 @@
IdentityServerHandshakeCompleted {
handle: HandshakeHandle,
endpoint_private_key: Ed25519PrivateKey,
- endpoint_name: String,
+ endpoint_name: String,
client_service_id: V3OnionServiceId,
client_auth_public_key: X25519PublicKey,
},
IdentityServerHandshakeRejected {
handle: HandshakeHandle,
- client_allowed: bool,
- client_requested_endpoint_valid: bool,
- client_proof_signature_valid: bool,
- client_auth_signature_valid: bool,
- challenge_response_valid: bool,
+ client_allowed: bool,
+ client_requested_endpoint_valid: bool,
+ client_proof_signature_valid: bool,
+ client_auth_signature_valid: bool,
+ challenge_response_valid: bool,
},
IdentityServerHandshakeFailed {
handle: HandshakeHandle,
@@ -58,8 +58,8 @@
EndpointClientHandshakeCompleted {
handle: HandshakeHandle,
endpoint_service_id: V3OnionServiceId,
- channel_name: String,
- stream: TcpStream,
+ channel_name: String,
+ stream: TcpStream,
},
EndpointClientHandshakeFailed {
handle: HandshakeHandle,
@@ -67,7 +67,7 @@
},
EndpointServerPublished {
endpoint_service_id: V3OnionServiceId,
- endpoint_name: String,
+ endpoint_name: String,
},
EndpointServerHandshakeStarted {
handle: HandshakeHandle,
@@ -75,20 +75,20 @@
EndpointServerChannelRequestReceived {
handle: HandshakeHandle,
client_service_id: V3OnionServiceId,
- requested_channel: String,
+ requested_channel: String,
},
EndpointServerHandshakeCompleted {
handle: HandshakeHandle,
endpoint_service_id: V3OnionServiceId,
client_service_id: V3OnionServiceId,
- channel_name: String,
- stream: TcpStream,
+ channel_name: String,
+ stream: TcpStream,
},
EndpointServerHandshakeRejected {
handle: HandshakeHandle,
- client_allowed: bool,
- client_requested_channel_valid: bool,
- client_proof_signature_valid: bool,
+ client_allowed: bool,
+ client_requested_channel_valid: bool,
+ client_proof_signature_valid: bool,
},
EndpointServerHandshakeFailed {
handle: HandshakeHandle,
@@ -96,12 +96,12 @@
},
}
Expand description
Events to signal completion of asynchronous Context operations
Variants§
§TorBootstrapStatusReceived
Tor bootstrap progress
-Fields
§summary: StringA longer human-readable summary of the bootstrap progress
+Fields
§TorBootstrapCompleted
Tor bootstrap completed
§TorLogReceived
Human-readable logs from the Context’s TorProvider
-Fields
§line: StringHuman-readable debug log
+§IdentityClientChallengeReceived
An identity client has received a challenge request from an identy server
To continue the handshake, the client must call Context::identity_client_handle_challenge_received()
Fields
§handle: HandshakeHandleThe handle of the in-progress handshake
@@ -110,7 +110,7 @@
Fields
§handle: HandshakeHandleThe handle of the completed handshake
§identity_service_id: V3OnionServiceIdThe onion-service service-id of the identity server the client has completed an identity handshake with
§endpoint_service_id: V3OnionServiceIdThe onion-service service-id of the requested endpoint server
-§client_auth_private_key: X25519PrivateKeyThe private x25519 client-auth key required to access the requested endpoint server
§IdentityClientHandshakeFailed
An incoming identit handshake has failed
Fields
§handle: HandshakeHandleThe handle of the failed handshake
@@ -122,7 +122,7 @@
To continue the handshake, the server must call Context::identity_server_handle_endpoint_request_received()
Fields
§handle: HandshakeHandleThe handle of the in-progress handshake
§client_service_id: V3OnionServiceIdThe alleged onion-service service-id of the connecting client
-§IdentityServerChallengeResponseReceived
An identity server has received a challenge response from an identity client.
To continue the handshake, the server must call Context::identity_server_handle_challenge_response_received()
Fields
§handle: HandshakeHandleThe handle of the in-progress handshake
@@ -130,172 +130,172 @@
§IdentityServerHandshakeCompleted
An identity server’s handshake has completed.
Fields
§handle: HandshakeHandleThe handle of the completed handshake
§endpoint_private_key: Ed25519PrivateKeyThe ed25519 private key of requested endpoint server
-§client_service_id: V3OnionServiceIdThe onion-service service-id of the authenticated client
§client_auth_public_key: X25519PublicKeyThe public x25519 client-auth key used to encrypt the endpoint server’s onion-service descriptor
§IdentityServerHandshakeRejected
An identity server has rejected an identity client’s endpoint-request.
There are multiple potential reasons why a handshake may be rejected and this event provides a breakdown on which part(s) failed specifically.
Fields
§handle: HandshakeHandleThe handle of the rejected handshake
-§client_requested_endpoint_valid: boolfalse if the requested endpoint name was not understood by the server
-§client_proof_signature_valid: boolfalse if the client failed its authentication proof (i.e. potential attempt at identity client impersonation)
-§client_auth_signature_valid: boolfalse if the client fails its x25519 key-ownership proof (i.e. potential attempt at use an x25519 public key not owned by the client)
-§client_requested_endpoint_valid: boolfalse if the requested endpoint name was not understood by the server
+§client_proof_signature_valid: boolfalse if the client failed its authentication proof (i.e. potential attempt at identity client impersonation)
+§IdentityServerHandshakeFailed
An incoming identity handshake has failed.
§EndpointClientHandshakeCompleted
An endpoint client has successfully completed an endpoint handshake and may now communicate freely with the endpoint server.
Fields
§handle: HandshakeHandleThe handle of the completed handshake
§endpoint_service_id: V3OnionServiceIdThe onion-service service-id of the endpoint server the client has connected to
-§EndpointClientHandshakeFailed
An outgoing endpoint handshake has failed.
§EndpointServerPublished
The endpoint server’s onion-service has been published and may be reachable by endpoint clients.
Fields
§endpoint_service_id: V3OnionServiceIdThe onion-service service-id of the published endpoint server
-§EndpointServerHandshakeStarted
An endpoint server has received an incoming connection and the handshake is ready to begin.
Fields
§handle: HandshakeHandleThe handle of the new handshake
§EndpointServerChannelRequestReceived
An endpoint server has received a request for a channel from an endpoint client.
To continue the handshake, the server must call Context::endpoint_server_handle_channel_request_received()
Fields
§handle: HandshakeHandleThe handle of the in-progress handshake
§client_service_id: V3OnionServiceIdThe alleged onion-service service-id of the connecting client
-§EndpointServerHandshakeCompleted
An endpoint server’s handshake has completed
Fields
§handle: HandshakeHandleThe handle of the completed handshake
§endpoint_service_id: V3OnionServiceIdThe onion-service service-id of the endpoint server which an endpoint client has connected to
§client_service_id: V3OnionServiceIdThe onion-service service-id of the connected client
-§EndpointServerHandshakeRejected
An endpoint server has rejected an endpoint client’s channel request.
There are multiple potential reasons why a handshake may be rejected and this event provides a breakdown on which part(s) failed specifically.
Fields
§handle: HandshakeHandleThe handle of the rejected handshake
-§client_requested_channel_valid: boolfalse if the requested channel name was not understood by the server
-§client_proof_signature_valid: boolfalse if the client failed its authentication proof (i.e. potential attempt at endpoint client impersonation)
+§EndpointServerHandshakeFailed
An incoming endpoint handshake has failed.
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ContextEvent
§impl !RefUnwindSafe for ContextEvent
§impl Send for ContextEvent
§impl Sync for ContextEvent
§impl Unpin for ContextEvent
§impl !UnwindSafe for ContextEvent
Blanket Implementations§
Trait Implementations§
Auto Trait Implementations§
§impl Freeze for ContextEvent
§impl !RefUnwindSafe for ContextEvent
§impl Send for ContextEvent
§impl Sync for ContextEvent
§impl Unpin for ContextEvent
§impl !UnwindSafe for ContextEvent
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
+ T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
- T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
-then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
-further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
-generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
+ T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
+then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
+further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
+generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
§fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
- Self: Display,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<Source, Target> OctetsInto<Target> for Sourcewhere
Target: OctetsFrom<Source>,
§type Error = <Target as OctetsFrom<Source>>::Error
§fn try_octets_into(
self,
-) -> Result<Target, <Source as OctetsInto<Target>>::Error>
Performs the conversion.§fn octets_into(self) -> Targetwhere
- Self::Error: Into<Infallible>,
Performs an infallible conversion.§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
- Self: Borrow<B>,
- B: 'a + ?Sized,
+) -> Result<Target, <Source as OctetsInto<Target>>::Error>Performs the conversion.§fn octets_into(self) -> Targetwhere
+ Self::Error: Into<Infallible>,
Performs an infallible conversion.
§impl<T> Pipe for Twhere
+ T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
- S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
+ S: Into<Dispatch>,§fn with_current_subscriber(self) -> WithDispatch<Self>
§impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> MaybeSendSync for T
\ No newline at end of file
diff --git a/crates/gosling/context/enum.Error.html b/crates/gosling/context/enum.Error.html
index ce637c79..574193ec 100644
--- a/crates/gosling/context/enum.Error.html
+++ b/crates/gosling/context/enum.Error.html
@@ -1,9 +1,9 @@
-Error in gosling::context - Rust pub enum Error {
- InvalidArgument(String),
+Error in gosling::context - Rust pub enum Error {
+ InvalidArgument(String),
TorNotConnected(),
HandshakeHandleNotFound(HandshakeHandle),
- IncorrectUsage(String),
- Io(Error),
+ IncorrectUsage(String),
+ Io(Error),
HonkRpc(Error),
TorCrypto(Error),
TorProvider(Error),
@@ -12,11 +12,11 @@
EndpointClientError(Error),
EndpointServerError(Error),
}
Expand description
The error type for the Context type.
-Variants§
§InvalidArgument(String)
An invalid argument was provided to a function
+Variants§
§InvalidArgument(String)
An invalid argument was provided to a function
§TorNotConnected()
Function requiring tor connectivity called before bootstrap
§HandshakeHandleNotFound(HandshakeHandle)
Provided handle does not map to an in-flight handshake
-§IncorrectUsage(String)
Requesting an invalid operation
-§Io(Error)
An underlying std::io::Error
+§IncorrectUsage(String)
Requesting an invalid operation
+§Io(Error)
An underlying std::io::Error
§HonkRpc(Error)
An underlying honk_rpc::honk_rpc::Error
§TorCrypto(Error)
An underlying tor_interface::tor_crypto::Error
§TorProvider(Error)
An underlying tor_interface::tor_provider::Error
@@ -24,128 +24,128 @@
§IdentityServerError(Error)
Failure ocurred in incoming identity handshake
§EndpointClientError(Error)
Failure ocurred in outgoing endpoint handshake
§EndpointServerError(Error)
Failure ocurred in incoming endpoint handshake
-Trait Implementations§
source§impl Error for Error
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
- T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
+
Trait Implementations§
source§impl Error for Error
source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
+ T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
- T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
-then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
-further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
-generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
+ T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
+then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
+further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
+generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
§fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
- Self: Display,
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
+ Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<Source, Target> OctetsInto<Target> for Sourcewhere
Target: OctetsFrom<Source>,
§type Error = <Target as OctetsFrom<Source>>::Error
§fn try_octets_into(
self,
-) -> Result<Target, <Source as OctetsInto<Target>>::Error>
Performs the conversion.§fn octets_into(self) -> Targetwhere
- Self::Error: Into<Infallible>,
Performs an infallible conversion.§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
- Self: Borrow<B>,
- B: 'a + ?Sized,
+) -> Result<Target, <Source as OctetsInto<Target>>::Error>Performs the conversion.§fn octets_into(self) -> Targetwhere
+ Self::Error: Into<Infallible>,
Performs an infallible conversion.
§impl<T> Pipe for Twhere
+ T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<T> TryIntoSlug for T
§fn try_into_slug(&self) -> Result<Slug, BadSlug>
Convert self into a Slug, if it has the right syntax§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
§impl<T> TryIntoSlug for T
§fn try_into_slug(&self) -> Result<Slug, BadSlug>
Convert self into a Slug, if it has the right syntax§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
- S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
+ S: Into<Dispatch>,§fn with_current_subscriber(self) -> WithDispatch<Self>
§impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> MaybeSendSync for T
\ No newline at end of file
diff --git a/crates/gosling/context/index.html b/crates/gosling/context/index.html
index c429ea53..1c9c5150 100644
--- a/crates/gosling/context/index.html
+++ b/crates/gosling/context/index.html
@@ -1,2 +1,2 @@
-gosling::context - Rust gosling::context - Rust Context in gosling::context - Rust pub struct Context { /* private fields */ }
Expand description
The gosling protocol implementation.
+Context in gosling::context - Rust pub struct Context { /* private fields */ }
Expand description
The gosling protocol implementation.
The Context object provides various methods for starting and progressing identity and endpoint handshakes. The general usage pattern developers will follow is to construct a Context object, connect to the Tor Network using Context::bootstrap(), optionally start an identity or endpoint servers, and listen for and handle incoming identity and endpoint clients using Context::update() and the various associated methods. Depending on the application’s requirements, the developer can also initiate identity and endpoint handshakes as necessary.
The Gosling Protocol specification can be found here:
Implementations§
source§impl Context
sourcepub fn new(
- tor_provider: Box<dyn TorProvider>,
- identity_port: u16,
- endpoint_port: u16,
- identity_timeout: Duration,
- identity_max_message_size: i32,
- endpoint_timeout: Option<Duration>,
+ tor_provider: Box<dyn TorProvider>,
+ identity_port: u16,
+ endpoint_port: u16,
+ identity_timeout: Duration,
+ identity_max_message_size: i32,
+ endpoint_timeout: Option<Duration>,
identity_private_key: Ed25519PrivateKey,
-) -> Result<Self, Error>
Construct a new Context object.
+) -> Result<Self, Error>Construct a new Context object.
§Parameters
tor_provider: an implementation of the TorProvider trait which provides our Tor Network connectivity§Parameters
§Returns
A newly constructed Context.
-
sourcepub fn bootstrap(&mut self) -> Result<(), Error>
Initiate bootstrap of the Context’s owned TorProvider. Bootstrap status is communicated through ContextEvents returned from the Context::update() method.
+sourcepub fn bootstrap(&mut self) -> Result<(), Error>
Initiate bootstrap of the Context’s owned TorProvider. Bootstrap status is communicated through ContextEvents returned from the Context::update() method.
sourcepub fn identity_client_begin_handshake(
&mut self,
identity_server_id: V3OnionServiceId,
- endpoint: String,
-) -> Result<HandshakeHandle, Error>
Initiate an identity handshake with an identity server. Handshake progression is communicated through ContextEvents returned from the Context::update() method.
+ endpoint: String,
+) -> Result<HandshakeHandle, Error>Initiate an identity handshake with an identity server. Handshake progression is communicated through ContextEvents returned from the Context::update() method.
§Parameters
identitity_server_id: the long term identity onion-service service-id of a remote peer§Returns
sourcepub fn identity_client_abort_handshake(
&mut self,
handle: HandshakeHandle,
-) -> Result<(), Error>
Abort an in-process outgoing identity handshake.
+) -> Result<(), Error>Abort an in-process outgoing identity handshake.
§Parameters
handle: the handle of the in-progress outoing identity handshake to abort§Parameter
&mut self,
handle: HandshakeHandle,
challenge_response: Document,
-) -> Result<(), Error>Handle an identity server’s endpoint challenge. Callers must construct an identity client’s endpoint challenge-response. The particulars of creating and verifying the challenge-response BSON documents are undefined and application-specific.
+) -> Result<(), Error>Handle an identity server’s endpoint challenge. Callers must construct an identity client’s endpoint challenge-response. The particulars of creating and verifying the challenge-response BSON documents are undefined and application-specific.
§Parameters
handle: the handle of the in-progress outgoing identity handshakechallenge_response: an application-specific BSON document which somehow responds to an identity server’s challenge.
-sourcepub fn identity_server_start(&mut self) -> Result<(), Error>
Start this Context’s identity server. Publish status is communicated through ContextEvents returned from the Context::update() method.
-sourcepub fn identity_server_stop(&mut self) -> Result<(), Error>
Stops this Context’s identity server and ends any in-progress incoming identity handshakes.
+sourcepub fn identity_server_start(&mut self) -> Result<(), Error>
Start this Context’s identity server. Publish status is communicated through ContextEvents returned from the Context::update() method.
+sourcepub fn identity_server_stop(&mut self) -> Result<(), Error>
Stops this Context’s identity server and ends any in-progress incoming identity handshakes.
sourcepub fn identity_server_handle_endpoint_request_received(
&mut self,
handle: HandshakeHandle,
- client_allowed: bool,
- endpoint_supported: bool,
+ client_allowed: bool,
+ endpoint_supported: bool,
endpoint_challenge: Document,
-) -> Result<(), Error>
Handle an identity client’s incoming endpoint request. Callers must determine whether the connected identity client is allowed to access the requested endpoint, decide whether the requested endpoint is supported by this Context, and build an endpoint challenge for the identity client. The particulars of creating the endpoint challenge is undefined and application-specific.
+) -> Result<(), Error>Handle an identity client’s incoming endpoint request. Callers must determine whether the connected identity client is allowed to access the requested endpoint, decide whether the requested endpoint is supported by this Context, and build an endpoint challenge for the identity client. The particulars of creating the endpoint challenge is undefined and application-specific.
§Parameters
handle: the handle of the in-progress incoming identity handshake§Parameter
sourcepub fn identity_server_handle_challenge_response_received(
&mut self,
handle: HandshakeHandle,
- challenge_response_valid: bool,
-) -> Result<(), Error>
Handle an identity client’s incoming endpoint challenge-response. Callers must determine whether the connected identity client’s challenge-response is valid. The particulars of verifying the challenge-response is undefined and application-specific.
+ challenge_response_valid: bool,
+) -> Result<(), Error>Handle an identity client’s incoming endpoint challenge-response. Callers must determine whether the connected identity client’s challenge-response is valid. The particulars of verifying the challenge-response is undefined and application-specific.
§Parameters
handle: the handle of the in-progress incoming identity handshake§Parameter
&mut self,
endpoint_server_id: V3OnionServiceId,
client_auth_key: X25519PrivateKey,
- channel: String,
-) -> Result<HandshakeHandle, Error>Initiate an endpoint handshake with an identity server. An endpoint client acquires the endpoint_server_id and client_auth_key by completing an identity handshake or through some other side-channnel. Handshake progression is communicated through ContextEvents returned from the Context::update() method.
+ channel: String,
+) -> Result<HandshakeHandle, Error>Initiate an endpoint handshake with an identity server. An endpoint client acquires the endpoint_server_id and client_auth_key by completing an identity handshake or through some other side-channnel. Handshake progression is communicated through ContextEvents returned from the Context::update() method.
§Parameters
endpoint_server_id: the endpoint onion-service service-id of a remote peer§Parameter
sourcepub fn endpoint_client_abort_handshake(
&mut self,
handle: HandshakeHandle,
-) -> Result<(), Error>
Abort an in-process outgoing endpoint handshake
+) -> Result<(), Error>Abort an in-process outgoing endpoint handshake
§Parameters
handle: the handle of the in-progress outoing identity handshake to abort§Parameter
sourcepub fn endpoint_server_start(
&mut self,
endpoint_private_key: Ed25519PrivateKey,
- endpoint_name: String,
+ endpoint_name: String,
client_identity: V3OnionServiceId,
client_auth: X25519PublicKey,
-) -> Result<(), Error>
Start one of this Context’s endpoint servers. Publish status is communicated through ContextEvents returned from the Context::update() method.
+) -> Result<(), Error>Start one of this Context’s endpoint servers. Publish status is communicated through ContextEvents returned from the Context::update() method.
§Parameters
endpoint_private_key: the ed25519 private key used to start this endpoint server’s onion-service§Parameter
sourcepub fn endpoint_server_handle_channel_request_received(
&mut self,
handle: HandshakeHandle,
- channel_supported: bool,
-) -> Result<(), Error>
Handle an endpoint client’s incoming channel request. Callers must determine whether the requested channel is supported by this Context. The particulars of making this determination is undefined and application-specific.
+ channel_supported: bool,
+) -> Result<(), Error>Handle an endpoint client’s incoming channel request. Callers must determine whether the requested channel is supported by this Context. The particulars of making this determination is undefined and application-specific.
§Parameters
handle: the handle of the in-progress incoming endpoint handshake§Parameter
sourcepub fn endpoint_server_stop(
&mut self,
endpoint_identity: V3OnionServiceId,
-) -> Result<(), Error>
Stop one of this Context’s endpoint servers and ends any of its in-progress incoming endpoint handshakes.
+) -> Result<(), Error>Stop one of this Context’s endpoint servers and ends any of its in-progress incoming endpoint handshakes.
§Parameters
endpoint_identity: the onion-service service-id of the enpdoint server to stop§Paramet
sourcepub fn connect(
&mut self,
target_addr: TargetAddr,
- circuit_token: Option<CircuitToken>,
-) -> Result<OnionStream, Error>
A direct pass-through to the underlying TorProvider’s TorProvider::connect() method.
+ circuit_token: Option<CircuitToken>,
+) -> Result<OnionStream, Error>A direct pass-through to the underlying TorProvider’s TorProvider::connect() method.
sourcepub fn generate_circuit_token(&mut self) -> CircuitToken
A direct pass-through to the underlying TorProvider’s TorProvider::generate_token() method.
sourcepub fn release_circuit_token(&mut self, circuit_token: CircuitToken)
A direct pass-through to the underlying TorProvider’s TorProvider::release_token() method.
-sourcepub fn update(&mut self) -> Result<VecDeque<ContextEvent>, Error>
This function updates the Context’s underlying TorProvider, handles new handshakes requests, and updates in-progress handshakes. This function needs to be regularly called to process the returned ContextEvents.
-Auto Trait Implementations§
§impl Freeze for Context
§impl !RefUnwindSafe for Context
§impl Send for Context
§impl !Sync for Context
§impl Unpin for Context
§impl !UnwindSafe for Context
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
- T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
+
sourcepub fn update(&mut self) -> Result<VecDeque<ContextEvent>, Error>
This function updates the Context’s underlying TorProvider, handles new handshakes requests, and updates in-progress handshakes. This function needs to be regularly called to process the returned ContextEvents.
+Auto Trait Implementations§
§impl Freeze for Context
§impl !RefUnwindSafe for Context
§impl Send for Context
§impl !Sync for Context
§impl Unpin for Context
§impl !UnwindSafe for Context
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
+ T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
- T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
-then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
-further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
-generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> Downcast for Twhere
+ T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
+then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
+further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
+generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
- Self: Display,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T> From<T> for T
source§fn from(t: T) -> T
Returns the argument unchanged.
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
source§impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<Source, Target> OctetsInto<Target> for Sourcewhere
Target: OctetsFrom<Source>,
§type Error = <Target as OctetsFrom<Source>>::Error
§fn try_octets_into(
self,
-) -> Result<Target, <Source as OctetsInto<Target>>::Error>
Performs the conversion.§fn octets_into(self) -> Targetwhere
- Self::Error: Into<Infallible>,
Performs an infallible conversion.§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
- Self: Borrow<B>,
- B: 'a + ?Sized,
+) -> Result<Target, <Source as OctetsInto<Target>>::Error>Performs the conversion.§fn octets_into(self) -> Targetwhere
+ Self::Error: Into<Infallible>,
Performs an infallible conversion.
§impl<T> Pipe for Twhere
+ T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
§impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
- S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
+ S: Into<Dispatch>,§fn with_current_subscriber(self) -> WithDispatch<Self>
§impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> MaybeSendSync for T
\ No newline at end of file
diff --git a/crates/gosling/context/type.HandshakeHandle.html b/crates/gosling/context/type.HandshakeHandle.html
index 822ca3a7..69325f13 100644
--- a/crates/gosling/context/type.HandshakeHandle.html
+++ b/crates/gosling/context/type.HandshakeHandle.html
@@ -1,2 +1,2 @@
-HandshakeHandle in gosling::context - Rust Type Alias gosling::context::HandshakeHandle
source · pub type HandshakeHandle = usize;
Expand description
A handle to an in-progres identity or endpoint handshake
+HandshakeHandle in gosling::context - Rust Type Alias gosling::context::HandshakeHandle
source · pub type HandshakeHandle = usize;
Expand description
A handle to an in-progres identity or endpoint handshake
gosling - Rust Expand description
§Gosling
+gosling - Rust Expand description
§Gosling
Gosling is a crate which encapsulates connecting to and authenticating with onion-service peers on the Tor Network. The authentication mechanism is based on and improves upon the peer authentication handshake found in Ricochet-Refresh.
Peer-to-peer applications can be built using Gosling with the following features by default:
diff --git a/crates/help.html b/crates/help.html
index efb3133b..05209302 100644
--- a/crates/help.html
+++ b/crates/help.html
@@ -1 +1 @@
-Help Rustdoc help
BackHelp Rustdoc help
BackList of all items in this crate List of all items
Structs
Enums
Traits
Functions
- honk_rpc::get_error_section_size
- honk_rpc::get_message_overhead
- honk_rpc::get_request_section_size
- honk_rpc::get_response_section_size
Type Aliases
Constants
List of all items in this crate List of all items
Structs
Enums
Traits
Functions
- honk_rpc::get_error_section_size
- honk_rpc::get_message_overhead
- honk_rpc::get_request_section_size
- honk_rpc::get_response_section_size
Type Aliases
Constants
DEFAULT_MAX_MESSAGE_SIZE in honk_rpc::honk_rpc - Rust Constant honk_rpc::honk_rpc::DEFAULT_MAX_MESSAGE_SIZE
source · pub const DEFAULT_MAX_MESSAGE_SIZE: usize = _; // 4_096usize
Expand description
The default maximum allowed Honk-RPC message (4096 bytes)
+DEFAULT_MAX_MESSAGE_SIZE in honk_rpc::honk_rpc - Rust Constant honk_rpc::honk_rpc::DEFAULT_MAX_MESSAGE_SIZE
source · pub const DEFAULT_MAX_MESSAGE_SIZE: usize = _; // 4_096usize
Expand description
The default maximum allowed Honk-RPC message (4096 bytes)
DEFAULT_MAX_WAIT_TIME in honk_rpc::honk_rpc - Rust Constant honk_rpc::honk_rpc::DEFAULT_MAX_WAIT_TIME
source · pub const DEFAULT_MAX_WAIT_TIME: Duration;
Expand description
The default maximum allowed duration between Honk-RPC (60 seconds)
+DEFAULT_MAX_WAIT_TIME in honk_rpc::honk_rpc - Rust Constant honk_rpc::honk_rpc::DEFAULT_MAX_WAIT_TIME
source · pub const DEFAULT_MAX_WAIT_TIME: Duration;
Expand description
The default maximum allowed duration between Honk-RPC (60 seconds)
Error in honk_rpc::honk_rpc - Rust pub enum Error {
- ReaderReadFailed(Error),
- BsonDocumentSizeTooSmall(i32),
- BsonDocumentSizeTooLarge(i32, i32),
- MessageReadTimedOut(Duration),
+Error in honk_rpc::honk_rpc - Rust pub enum Error {
+ ReaderReadFailed(Error),
+ BsonDocumentSizeTooSmall(i32),
+ BsonDocumentSizeTooLarge(i32, i32),
+ MessageReadTimedOut(Duration),
BsonDocumentParseFailed(Error),
MessageConversionFailed(ErrorCode),
BsonWriteFailed(Error),
- WriterWriteFailed(Error),
- WriterFlushFailed(Error),
+ WriterWriteFailed(Error),
+ WriterFlushFailed(Error),
UnknownErrorSectionReceived(ErrorCode),
InvalidMaxMesageSize(),
- SectionTooLarge(usize, usize),
+ SectionTooLarge(usize, usize),
}
Expand description
The error type for the Session type.
-Variants§
§ReaderReadFailed(Error)
Failed to read data from read stream due to std::io::Error
-§BsonDocumentSizeTooSmall(i32)
Bson documents need to be at least 4 bytes long
-§BsonDocumentSizeTooLarge(i32, i32)
Received Bson document header is larger than Session supports
-§MessageReadTimedOut(Duration)
Too much time has elapsed without receiving a message
+Variants§
§ReaderReadFailed(Error)
Failed to read data from read stream due to std::io::Error
+§BsonDocumentSizeTooSmall(i32)
Bson documents need to be at least 4 bytes long
+§BsonDocumentSizeTooLarge(i32, i32)
Received Bson document header is larger than Session supports
+§MessageReadTimedOut(Duration)
Too much time has elapsed without receiving a message
§BsonDocumentParseFailed(Error)
Failed to parse bson message
§MessageConversionFailed(ErrorCode)
Failed to convert bson document to Honk-RPC message
§BsonWriteFailed(Error)
Failed to serialise bson document
-§WriterWriteFailed(Error)
Failed to write data to write stream due to std::io::Error
-§WriterFlushFailed(Error)
Failed to flush data to write stream due to std::io::Error
+§WriterWriteFailed(Error)
Failed to write data to write stream due to std::io::Error
+§WriterFlushFailed(Error)
Failed to flush data to write stream due to std::io::Error
§UnknownErrorSectionReceived(ErrorCode)
Received a Honk-RPC error_section without an associated request cookie
§InvalidMaxMesageSize()
Attempted to define invalid maximum message size
-§SectionTooLarge(usize, usize)
Attempted to send a Honk-RPC section that is too large to fit in a message
-Trait Implementations§
source§impl Error for Error
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.Trait Implementations§
source§impl Error for Error
source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()Auto Trait Implementations§
§impl Freeze for Error
§impl !RefUnwindSafe for Error
§impl Send for Error
§impl Sync for Error
§impl Unpin for Error
§impl !UnwindSafe for Error
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
+ Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T, U> Into<U> for Twhere
- U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
\ No newline at end of file
diff --git a/crates/honk_rpc/honk_rpc/enum.ErrorCode.html b/crates/honk_rpc/honk_rpc/enum.ErrorCode.html
index 1c835caa..fbda94e7 100644
--- a/crates/honk_rpc/honk_rpc/enum.ErrorCode.html
+++ b/crates/honk_rpc/honk_rpc/enum.ErrorCode.html
@@ -1,4 +1,4 @@
-ErrorCode in honk_rpc::honk_rpc - Rust pub enum ErrorCode {
+ErrorCode in honk_rpc::honk_rpc - Rust pub enum ErrorCode {
}
Expand description
Represents various error codes that can be present in a Honk-RPC error_section
Variants§
§BsonParseFailed
Failure to parse a received BSON document.
§MessageTooBig
Received message document was too big; the default maximum message size
@@ -28,103 +28,102 @@
§RequestVersionInvalid
Provided request version does not exist.
§ResponseCookieInvalid
Provided response cookie is not recognized.
§ResponseStateInvalid
Provided response state is not valid.
-§Runtime(i32)
Represents an application-specific runtime error with a specific error code.
-§Unknown(i32)
Represents an unknown error with a specific error code.
-Trait Implementations§
source§impl Error for ErrorCode
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl PartialEq for ErrorCode
source§impl Eq for ErrorCode
source§impl StructuralPartialEq for ErrorCode
Auto Trait Implementations§
§impl Freeze for ErrorCode
§impl RefUnwindSafe for ErrorCode
§impl Send for ErrorCode
§impl Sync for ErrorCode
§impl Unpin for ErrorCode
§impl UnwindSafe for ErrorCode
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more§impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
Compare self to key and return true if they are equal.§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.Trait Implementations§
source§impl Error for ErrorCode
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl Eq for ErrorCode
source§impl StructuralPartialEq for ErrorCode
Auto Trait Implementations§
§impl Freeze for ErrorCode
§impl RefUnwindSafe for ErrorCode
§impl Send for ErrorCode
§impl Sync for ErrorCode
§impl Unpin for ErrorCode
§impl UnwindSafe for ErrorCode
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more§impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
Compare self to key and return true if they are equal.§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
+ Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T, U> Into<U> for Twhere
- U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
\ No newline at end of file
diff --git a/crates/honk_rpc/honk_rpc/enum.Response.html b/crates/honk_rpc/honk_rpc/enum.Response.html
index 3f9eaa3d..8efa9888 100644
--- a/crates/honk_rpc/honk_rpc/enum.Response.html
+++ b/crates/honk_rpc/honk_rpc/enum.Response.html
@@ -1,10 +1,10 @@
-Response in honk_rpc::honk_rpc - Rust pub enum Response {
+Response in honk_rpc::honk_rpc - Rust pub enum Response {
Pending {
cookie: RequestCookie,
},
Success {
cookie: RequestCookie,
- result: Option<Bson>,
+ result: Option<Bson>,
},
Error {
cookie: RequestCookie,
@@ -15,98 +15,98 @@
Fields
The cookie associated with the request.
§Success
A successful response, containing the result of the request.
Fields
The cookie associated with the request.
-§Error
An error response, containing the error code.
Auto Trait Implementations§
§impl Freeze for Response
§impl RefUnwindSafe for Response
§impl Send for Response
§impl Sync for Response
§impl Unpin for Response
§impl UnwindSafe for Response
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
- Self: Display,
Causes self to use its Display implementation when
+Auto Trait Implementations§
§impl Freeze for Response
§impl RefUnwindSafe for Response
§impl Send for Response
§impl Sync for Response
§impl Unpin for Response
§impl UnwindSafe for Response
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
+ Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T, U> Into<U> for Twhere
- U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
get_error_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_error_section_size
source · pub fn get_error_section_size(
- cookie: Option<RequestCookie>,
- message: Option<String>,
- data: Option<Bson>,
-) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC error section in bytes.
+get_error_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_error_section_size
source · pub fn get_error_section_size(
+ cookie: Option<RequestCookie>,
+ message: Option<String>,
+ data: Option<Bson>,
+) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC error section in bytes.
Returns the size of the BSON-encoded error section. If BSON encoding fails,
an Error::BsonWriteFailed is returned.
get_message_overhead in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_message_overhead
source · pub fn get_message_overhead() -> Result<usize, Error>
Expand description
Computes the overhead of the Honk-RPC message type. This method in conjunction with
+
get_message_overhead in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_message_overhead
source · pub fn get_message_overhead() -> Result<usize, Error>
Expand description
Computes the overhead of the Honk-RPC message type. This method in conjunction with
the other get_*_section_size(..) functions can be used to compute the size of a
Honk-RPC message with exactly one section.
get_request_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_request_section_size
source · pub fn get_request_section_size(
- cookie: Option<RequestCookie>,
- namespace: Option<String>,
- function: String,
- version: Option<i32>,
- arguments: Option<Document>,
-) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC requests section in bytes.
+get_request_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_request_section_size
source · pub fn get_request_section_size(
+ cookie: Option<RequestCookie>,
+ namespace: Option<String>,
+ function: String,
+ version: Option<i32>,
+ arguments: Option<Document>,
+) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC requests section in bytes.
Returns the size of the BSON-encoded request section. If BSON encoding fails,
an Error::BsonWriteFailed is returned.
get_response_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_response_section_size
source · pub fn get_response_section_size(result: Option<Bson>) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC response section in bytes.
+get_response_section_size in honk_rpc::honk_rpc - Rust Function honk_rpc::honk_rpc::get_response_section_size
source · pub fn get_response_section_size(result: Option<Bson>) -> Result<usize, Error>
Expand description
Computes the required size of a Honk-RPC response section in bytes.
Returns the size of the BSON-encoded response section. If BSON encoding fails,
an Error::BsonWriteFailed is returned.
honk_rpc::honk_rpc - Rust Structs§
- The object that handles the communication between two endpoints using the
+
honk_rpc::honk_rpc - Rust Structs§
- The object that handles the communication between two endpoints using the
Honk-RPC protocol. Provides methods for setting and getting configuration
parameters, reading and processing message documents, and handling API
-requests and responses.
Enums§
- The error type for the
Session type. - Represents various error codes that can be present in a Honk-RPC
error_section - Represents the response to a client request.
Constants§
- The default maximum allowed Honk-RPC message (4096 bytes)
- The default maximum allowed duration between Honk-RPC (60 seconds)
Traits§
- The
ApiSet trait represents a set of APIs that can be remotely invoked by a connecting Honk-RPC client.
Functions§
- Computes the required size of a Honk-RPC error section in bytes.
- Computes the overhead of the Honk-RPC message type. This method in conjunction with
+requests and responses.
Enums§
- The error type for the
Session type. - Represents various error codes that can be present in a Honk-RPC
error_section - Represents the response to a client request.
Constants§
- The default maximum allowed Honk-RPC message (4096 bytes)
- The default maximum allowed duration between Honk-RPC (60 seconds)
Traits§
- The
ApiSet trait represents a set of APIs that can be remotely invoked by a connecting Honk-RPC client.
Functions§
- Computes the required size of a Honk-RPC error section in bytes.
- Computes the overhead of the Honk-RPC message type. This method in conjunction with
the other
get_*_section_size(..) functions can be used to compute the size of a
-Honk-RPC message with exactly one section. - Computes the required size of a Honk-RPC requests section in bytes.
- Computes the required size of a Honk-RPC response section in bytes.
Type Aliases§
- A type alias for the cookie used to track client requests.
- Computes the required size of a Honk-RPC requests section in bytes.
- Computes the required size of a Honk-RPC response section in bytes.
Type Aliases§
- A type alias for the cookie used to track client requests.
Session in honk_rpc::honk_rpc - Rust pub struct Session<RW> { /* private fields */ }
Expand description
The object that handles the communication between two endpoints using the
+
Session in honk_rpc::honk_rpc - Rust pub struct Session<RW> { /* private fields */ }
Expand description
The object that handles the communication between two endpoints using the
Honk-RPC protocol. Provides methods for setting and getting configuration
parameters, reading and processing message documents, and handling API
requests and responses.
Implementations§
source§impl<RW> Session<RW>
sourcepub fn set_max_message_size(
+ RW: Read + Write + Send,
sourcepub fn set_max_message_size(
&mut self,
- max_message_size: i32,
-) -> Result<(), Error>
Sets the maximum message size this Session is willing to read from from the underlying RW. Attempted reads will abort if the next bson document’s i32 size field is greater than the max_message_size defined in this function.
-sourcepub fn get_max_message_size(&self) -> usize
Gets the maximum allowed message size this Session is willing to read from the underlying RW. The default value is 4096 bytes.
-sourcepub fn set_max_wait_time(&mut self, max_wait_time: Duration)
Sets the maximum amount of time this Session is willing to wait for a new Honk-RPC message on the underlying RW. Session updates will fil after max_wait_time has elapsed without receiving any new Honk-RPC message documents.
-sourcepub fn get_max_wait_time(&self) -> Duration
Gets the maximum amount this Session is willing to wait for a new Honk-RPC message. The default value is 60 seconds.
+ max_message_size: i32,
+) -> Result<(), Error>Sets the maximum message size this Session is willing to read from from the underlying RW. Attempted reads will abort if the next bson document’s i32 size field is greater than the max_message_size defined in this function.
+sourcepub fn get_max_message_size(&self) -> usize
Gets the maximum allowed message size this Session is willing to read from the underlying RW. The default value is 4096 bytes.
+sourcepub fn set_max_wait_time(&mut self, max_wait_time: Duration)
Sets the maximum amount of time this Session is willing to wait for a new Honk-RPC message on the underlying RW. Session updates will fil after max_wait_time has elapsed without receiving any new Honk-RPC message documents.
+sourcepub fn get_max_wait_time(&self) -> Duration
Gets the maximum amount this Session is willing to wait for a new Honk-RPC message. The default value is 60 seconds.
sourcepub fn into_stream(self) -> RW
Consumes the Session and returns the underlying stream.
sourcepub fn update(
&mut self,
- apisets: Option<&mut [&mut dyn ApiSet]>,
-) -> Result<(), Error>
Read and process Honk-RPC message documents from connected peer, handle any new incoming Honk-RPC requests, update any in-progress async requests and write pending reponses, errors and requests to peer. This function must be called regularly for the Session to make forward progress.
+ apisets: Option<&mut [&mut dyn ApiSet]>,
+) -> Result<(), Error>Read and process Honk-RPC message documents from connected peer, handle any new incoming Honk-RPC requests, update any in-progress async requests and write pending reponses, errors and requests to peer. This function must be called regularly for the Session to make forward progress.
sourcepub fn client_call(
&mut self,
- namespace: &str,
- function: &str,
- version: i32,
+ namespace: &str,
+ function: &str,
+ version: i32,
arguments: Document,
-) -> Result<RequestCookie, Error>
Performs a client call to a remote function. Returns a RequestCookie to associate this client call with a future Response.
-sourcepub fn client_drain_responses(&mut self) -> Drain<'_, Response>
Drains all Response objects resulting from prevoius invocations of Session::client_call()
-sourcepub fn client_next_response(&mut self) -> Option<Response>
Retrieves the next Response object from previous invocations of Session::client_call()
-Auto Trait Implementations§
§impl<RW> Freeze for Session<RW>where
- RW: Freeze,
§impl<RW> RefUnwindSafe for Session<RW>where
- RW: RefUnwindSafe,
§impl<RW> Send for Session<RW>where
- RW: Send,
§impl<RW> Sync for Session<RW>where
- RW: Sync,
§impl<RW> Unpin for Session<RW>where
- RW: Unpin,
§impl<RW> UnwindSafe for Session<RW>where
- RW: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
- T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
- Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
- Self: Display,
Causes self to use its Display implementation when
+) -> Result<RequestCookie, Error>Performs a client call to a remote function. Returns a RequestCookie to associate this client call with a future Response.
+sourcepub fn client_drain_responses(&mut self) -> Drain<'_, Response>
Drains all Response objects resulting from prevoius invocations of Session::client_call()
+sourcepub fn client_next_response(&mut self) -> Option<Response>
Retrieves the next Response object from previous invocations of Session::client_call()
+Auto Trait Implementations§
§impl<RW> Freeze for Session<RW>where
+ RW: Freeze,
§impl<RW> RefUnwindSafe for Session<RW>where
+ RW: RefUnwindSafe,
§impl<RW> Send for Session<RW>where
+ RW: Send,
§impl<RW> Sync for Session<RW>where
+ RW: Sync,
§impl<RW> Unpin for Session<RW>where
+ RW: Unpin,
§impl<RW> UnwindSafe for Session<RW>where
+ RW: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
+ T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more§impl<T> Conv for T
§impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
+ Self: Binary,
Causes self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
+ Self: Display,
Causes self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
- Self: LowerExp,
Causes self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
- Self: LowerHex,
Causes self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
- Self: Octal,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
- Self: Pointer,
Causes self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
+ Self: Pointer,
Causes self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
- Self: UpperExp,
Causes self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
- Self: UpperHex,
Causes self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
- &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read moresource§impl<T, U> Into<U> for Twhere
- U: From<T>,
source§fn into(self) -> U
Calls U::from(self).
+ &'a Self: for<'a> IntoIterator,Formats each item in a sequence. Read more§impl<T> Pipe for Twhere
- T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
- Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
- R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
- R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
+ Self: Sized,
Pipes by value. This is generally the method you want to use. Read more§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
+ R: 'a,
Borrows self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
+ R: 'a,
Mutably borrows self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
- func: impl FnOnce(&'a mut B) -> R,
+ func: impl FnOnce(&'a mut B) -> R,
) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows self, then passes self.as_mut() into the pipe
-function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows self, then passes self.deref() into the pipe function.§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
-builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
-builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
-builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
-builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
-builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
-builds.§impl<T> TryConv for T
§impl<V, T> VZip<V> for Twhere
+function.
§impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut() only in debug builds, and is erased in release
+builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls .tap_borrow() only in debug builds, and is erased in release
+builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls .tap_borrow_mut() only in debug builds, and is erased in release
+builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls .tap_ref() only in debug builds, and is erased in release
+builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls .tap_ref_mut() only in debug builds, and is erased in release
+builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls .tap_deref() only in debug builds, and is erased in release
+builds.§impl<T> TryConv for T
\ No newline at end of file
diff --git a/crates/honk_rpc/honk_rpc/trait.ApiSet.html b/crates/honk_rpc/honk_rpc/trait.ApiSet.html
index 2eec8083..d6a43c80 100644
--- a/crates/honk_rpc/honk_rpc/trait.ApiSet.html
+++ b/crates/honk_rpc/honk_rpc/trait.ApiSet.html
@@ -1,19 +1,19 @@
-ApiSet in honk_rpc::honk_rpc - Rust pub trait ApiSet {
+ApiSet in honk_rpc::honk_rpc - Rust pub trait ApiSet {
// Required methods
- fn namespace(&self) -> &str;
+ fn namespace(&self) -> &str;
fn exec_function(
&mut self,
- name: &str,
- version: i32,
+ name: &str,
+ version: i32,
args: Document,
- request_cookie: Option<RequestCookie>,
- ) -> Option<Result<Option<Bson>, ErrorCode>>;
+ request_cookie: Option<RequestCookie>,
+ ) -> Option<Result<Option<Bson>, ErrorCode>>;
// Provided methods
fn update(&mut self) { ... }
fn next_result(
&mut self,
- ) -> Option<(RequestCookie, Result<Option<Bson>, ErrorCode>)> { ... }
+ ) -> Option<(RequestCookie, Result<Option<Bson>, ErrorCode>)> { ... }
}
Required Methods§
Required Methods§
sourcefn exec_function(
&mut self,
- name: &str,
- version: i32,
+ name: &str,
+ version: i32,
args: Document,
- request_cookie: Option<RequestCookie>,
-) -> Option<Result<Option<Bson>, ErrorCode>>
Schedules the execution of the requested remote procedure call. Calls to this
+ request_cookie: Option<RequestCookie>,
+) -> Option<Result<Option<Bson>, ErrorCode>>
Schedules the execution of the requested remote procedure call. Calls to this
function map directly to a received Honk-RPC request. Each request has the
following parameters:
@@ -130,7 +130,7 @@ §Example
function is a no-op.
sourcefn next_result(
&mut self,
-) -> Option<(RequestCookie, Result<Option<Bson>, ErrorCode>)>
Returns the result of any in-flight asynchronous requests.
+) -> Option<(RequestCookie, Result<Option<Bson>, ErrorCode>)>Returns the result of any in-flight asynchronous requests.
- Asynchronous requests may signal success by returning
Some((cookie, Ok(..)))
- Asynchronous requests may signal failure by returning
Some((cookie, Err(..)))
diff --git a/crates/honk_rpc/honk_rpc/type.RequestCookie.html b/crates/honk_rpc/honk_rpc/type.RequestCookie.html
index 31ac25b4..59398106 100644
--- a/crates/honk_rpc/honk_rpc/type.RequestCookie.html
+++ b/crates/honk_rpc/honk_rpc/type.RequestCookie.html
@@ -1,2 +1,2 @@
-RequestCookie in honk_rpc::honk_rpc - Rust Type Alias honk_rpc::honk_rpc::RequestCookie
source · pub type RequestCookie = i64;
Expand description
A type alias for the cookie used to track client requests.
+RequestCookie in honk_rpc::honk_rpc - Rust Type Alias honk_rpc::honk_rpc::RequestCookie
source · pub type RequestCookie = i64;
Expand description
A type alias for the cookie used to track client requests.
honk_rpc - Rust Expand description
§Honk-RPC
+honk_rpc - Rust Expand description
§Honk-RPC
Implementation of the Honk-RPC remote procedure call protocol.
§Overview
The honk-rpc crate is a bare-bones implementation of the Honk-RPC protocol. This protocol is heavily inspired by JSON-RPC, but uses BSON as the underlying message format to enable more efficient transmission of large binary payloads.
@@ -6,4 +6,4 @@ §Overview
For now, communications are presumed to take place over a Rust object implementing both std::io::Read and std::io::Write. In practice, this is presumed to be a std::io::TcpStream.
§⚠ Unstable ⚠
The honk-rpc crate’s API and the Honk-RPC protocol specification are considered unstable. The honk-rpc crate will likely be changed in the future to operate purely on bson objects and lave the specifics of the transport layer up to consumers of the crate.
-Modules§
Modules§
Settings Rustdoc settings
BackSettings Rustdoc settings
Backascii_string.rs - source 1
+ascii_string.rs - source 1
2
3
4
diff --git a/crates/src/gosling/context.rs.html b/crates/src/gosling/context.rs.html
index 093ac1e7..dcdfa707 100644
--- a/crates/src/gosling/context.rs.html
+++ b/crates/src/gosling/context.rs.html
@@ -1,4 +1,4 @@
-context.rs - source 1
+context.rs - source 1
2
3
4
diff --git a/crates/src/gosling/endpoint_client.rs.html b/crates/src/gosling/endpoint_client.rs.html
index 6f2ee788..7b3a4bf0 100644
--- a/crates/src/gosling/endpoint_client.rs.html
+++ b/crates/src/gosling/endpoint_client.rs.html
@@ -1,4 +1,4 @@
-endpoint_client.rs - source 1
+endpoint_client.rs - source 1
2
3
4
diff --git a/crates/src/gosling/endpoint_server.rs.html b/crates/src/gosling/endpoint_server.rs.html
index dbb8fa87..73451a3d 100644
--- a/crates/src/gosling/endpoint_server.rs.html
+++ b/crates/src/gosling/endpoint_server.rs.html
@@ -1,4 +1,4 @@
-endpoint_server.rs - source 1
+endpoint_server.rs - source 1
2
3
4
diff --git a/crates/src/gosling/gosling.rs.html b/crates/src/gosling/gosling.rs.html
index 1d5fe17e..70eaac4c 100644
--- a/crates/src/gosling/gosling.rs.html
+++ b/crates/src/gosling/gosling.rs.html
@@ -1,4 +1,4 @@
-gosling.rs - source 1
+gosling.rs - source 1
2
3
4
diff --git a/crates/src/gosling/identity_client.rs.html b/crates/src/gosling/identity_client.rs.html
index 4e0c500e..b70ce0a1 100644
--- a/crates/src/gosling/identity_client.rs.html
+++ b/crates/src/gosling/identity_client.rs.html
@@ -1,4 +1,4 @@
-identity_client.rs - source 1
+identity_client.rs - source