Some miscellaneous C API improvements (#13191)

* Some miscellaneous C API improvements

This commit goes through the C API and fixes a number of mistakes such
as typos, copy/paste errors, missing `const`, etc.

* Run clang-format

Author: alexcrichton

crates/c-api/include/wasmtime/_eqref_class.hh

@@ -1,6 +1,7 @@
 #ifndef WASMTIME_EQREF_CLASS_HH
 #define WASMTIME_EQREF_CLASS_HH
 
+#include <optional>
 #include <wasmtime/conf.h>
 
 #ifdef WASMTIME_FEATURE_GC
@@ -74,12 +75,12 @@ public:
   /// Downcast this `eqref` into a `structref`.
   //
   // as_struct() defined after StructRef below.
-  StructRef as_struct(Store::Context cx) const;
+  std::optional<StructRef> as_struct(Store::Context cx) const;
 
   /// Downcast this `eqref` into an `arrayref`.
   //
   // as_array() defined after ArrayRef below.
-  ArrayRef as_array(Store::Context cx) const;
+  std::optional<ArrayRef> as_array(Store::Context cx) const;
 };
 
 } // namespace wasmtime

crates/c-api/include/wasmtime/async.h

@@ -65,7 +65,7 @@ extern "C" {
  * For more information see the Rust documentation at
  * https://docs.wasmtime.dev/api/wasmtime/struct.Config.html#method.async_stack_size
  */
-WASMTIME_CONFIG_PROP(void, async_stack_size, uint64_t)
+WASMTIME_CONFIG_PROP(void, async_stack_size, size_t)
 
 /**
  * \brief Configures a Store to yield execution of async WebAssembly code
@@ -184,7 +184,7 @@ typedef struct wasmtime_call_future wasmtime_call_future_t;
 WASM_API_EXTERN bool wasmtime_call_future_poll(wasmtime_call_future_t *future);
 
 /**
- * /brief Frees the underlying memory for a future.
+ * \brief Frees the underlying memory for a future.
  *
  * All wasmtime_call_future_t are owned by the caller and should be deleted
  * using this function.

crates/c-api/include/wasmtime/component/component.h

@@ -106,7 +106,7 @@ wasmtime_component_clone(const wasmtime_component_t *component);
 /**
  * \brief Returns the type of this component.
  *
- * The returned pointer must be deallocatd with
+ * The returned pointer must be deallocated with
  * `wasmtime_component_type_delete`.
  */
 WASM_API_EXTERN wasmtime_component_type_t *

crates/c-api/include/wasmtime/component/component.hh

@@ -153,8 +153,8 @@ class Component {
    * The `instance` argument is an optionally provided index which is the
    * instance under which the `name` should be looked up.
    */
-  std::optional<ExportIndex> export_index(ExportIndex *instance,
-                                          std::string_view name) {
+  std::optional<ExportIndex> export_index(const ExportIndex *instance,
+                                          std::string_view name) const {
     auto ret = wasmtime_component_get_export_index(
         capi(), instance ? instance->capi() : nullptr, name.data(),
         name.size());

crates/c-api/include/wasmtime/component/func.hh

@@ -19,7 +19,7 @@ namespace wasmtime {
 namespace component {
 
 /**
- * \brief Class representing an instantiated WebAssembly component.
+ * \brief Class representing a WebAssembly component function.
  */
 class Func {
   wasmtime_component_func_t func;
@@ -67,4 +67,4 @@ public:
 
 #endif // WASMTIME_FEATURE_COMPONENT_MODEL
 
-#endif // WASMTIME_COMPONENT_FUNC_H
+#endif // WASMTIME_COMPONENT_FUNC_HH

crates/c-api/include/wasmtime/component/instance.hh

@@ -67,4 +67,4 @@ public:
 
 #endif // WASMTIME_FEATURE_COMPONENT_MODEL
 
-#endif // WASMTIME_COMPONENT_INSTANCE_H
+#endif // WASMTIME_COMPONENT_INSTANCE_HH

crates/c-api/include/wasmtime/component/linker.hh

@@ -31,7 +31,8 @@ class LinkerInstance {
   /**
    * \brief Adds a module to this linker instance under the specified name.
    */
-  Result<std::monostate> add_module(std::string_view name, Module &module) {
+  Result<std::monostate> add_module(std::string_view name,
+                                    const Module &module) {
     wasmtime_error_t *error = wasmtime_component_linker_instance_add_module(
         ptr.get(), name.data(), name.size(), module.capi());
     if (error != nullptr) {
@@ -188,7 +189,7 @@ class Linker {
   }
 
   /// \brief Instantiates the given component within this linker.
-  Result<Instance> instantiate(Store::Context cx, Component &component) {
+  Result<Instance> instantiate(Store::Context cx, const Component &component) {
     wasmtime_component_instance_t ret;
     wasmtime_error_t *error = wasmtime_component_linker_instantiate(
         ptr.get(), cx.capi(), component.capi(), &ret);
@@ -277,4 +278,4 @@ class Linker {
 
 #endif // WASMTIME_FEATURE_COMPONENT_MODEL
 
-#endif // WASMTIME_COMPONENT_LINKER_H
+#endif // WASMTIME_COMPONENT_LINKER_HH

crates/c-api/include/wasmtime/component/types/component.h

@@ -23,8 +23,8 @@ typedef struct wasmtime_component_type_t wasmtime_component_type_t;
 
 /// \brief Clones a component type.
 ///
-/// The returned pointer must be deallocated wit
-/// h`wasmtime_component_type_delete`.
+/// The returned pointer must be deallocated with
+/// `wasmtime_component_type_delete`.
 WASM_API_EXTERN
 wasmtime_component_type_t *
 wasmtime_component_type_clone(const wasmtime_component_type_t *ty);

crates/c-api/include/wasmtime/component/types/func.h

@@ -25,7 +25,7 @@ WASM_API_EXTERN
 wasmtime_component_func_type_t *
 wasmtime_component_func_type_clone(const wasmtime_component_func_type_t *ty);
 
-/// \brief Deallocates a component instance type.
+/// \brief Deallocates a component function type.
 WASM_API_EXTERN
 void wasmtime_component_func_type_delete(wasmtime_component_func_type_t *ty);
 

crates/c-api/include/wasmtime/component/types/module.h

@@ -24,7 +24,7 @@ WASM_API_EXTERN
 wasmtime_module_type_t *
 wasmtime_module_type_clone(const wasmtime_module_type_t *ty);
 
-/// \brief Deallocates a component instance type.
+/// \brief Deallocates a module type.
 WASM_API_EXTERN
 void wasmtime_module_type_delete(wasmtime_module_type_t *ty);