expo-modules-jsi 56.0.7 → 56.0.8

package/apple/Sources/ExpoModulesJSI/Runtime/JavaScriptValuesBuffer.swift

@@ -1,10 +1,8 @@
 internal import jsi
 
-/**
- A buffer that stores instances of `facebook.jsi.Value` with the ability to convert them to `JavaScriptValue` on element access
- without the need to create a new container (e.g. `std.vector<facebook.jsi.Value>` or `[JavaScriptValue]`).
- Used mainly to pass function arguments from C++ to Swift.
- */
+/// A buffer that stores instances of `facebook.jsi.Value` with the ability to convert them to `JavaScriptValue` on element access
+/// without the need to create a new container (e.g. `std.vector<facebook.jsi.Value>` or `[JavaScriptValue]`).
+/// Used mainly to pass function arguments from C++ to Swift.
 public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
   // Safe to use unowned — the buffer's lifetime is scoped to a host function call,
   // so the runtime is always alive while the buffer exists.
@@ -13,38 +11,37 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
   internal nonisolated(unsafe) let bufferPointer: UnsafeMutableBufferPointer<facebook.jsi.Value>
   private let ownsMemory: Bool
 
-  /**
-   A pointer to the first value of the buffer.
-   If the baseAddress of this buffer is `nil`, the `count` is zero.
-   */
+  /// A pointer to the first value of the buffer.
+  /// If the baseAddress of this buffer is `nil`, the `count` is zero.
   internal var baseAddress: UnsafePointer<facebook.jsi.Value>? {
     return UnsafePointer(bufferPointer.baseAddress)
   }
 
-  /**
-   A type-erased raw pointer to the first value of the buffer, suitable for
-   passing across Swift/ObjC++ boundaries where `facebook.jsi.Value` cannot
-   appear in a public signature.
-   */
+  /// A type-erased raw pointer to the first value of the buffer, suitable for
+  /// passing across Swift/ObjC++ boundaries where `facebook.jsi.Value` cannot
+  /// appear in a public signature.
   public var rawBaseAddress: UnsafeRawPointer? {
     return baseAddress.map { UnsafeRawPointer($0) }
   }
 
-  /**
-   The number of values in the buffer.
-   */
+  /// The number of values in the buffer.
   public var count: Int {
     return bufferPointer.count
   }
 
-  internal init(_ runtime: JavaScriptRuntime, buffer: consuming UnsafeMutableBufferPointer<facebook.jsi.Value>, ownsMemory: Bool = false) {
+  internal init(
+    _ runtime: JavaScriptRuntime, buffer: consuming UnsafeMutableBufferPointer<facebook.jsi.Value>,
+    ownsMemory: Bool = false
+  ) {
     self.runtime = runtime
     self.bufferPointer = buffer
     self.ownsMemory = ownsMemory
   }
 
   internal init(_ runtime: JavaScriptRuntime, start: consuming UnsafePointer<facebook.jsi.Value>?, count: Int) {
-    self.init(runtime, buffer: UnsafeMutableBufferPointer(start: UnsafeMutablePointer(mutating: start), count: count), ownsMemory: false)
+    self.init(
+      runtime, buffer: UnsafeMutableBufferPointer(start: UnsafeMutablePointer(mutating: start), count: count),
+      ownsMemory: false)
   }
 
   internal init(_ runtime: JavaScriptRuntime, buffer: consuming UnsafeBufferPointer<facebook.jsi.Value>) {
@@ -65,7 +62,8 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
   }
 
   @discardableResult
-  internal consuming func set<T: JSIRepresentable>(value: borrowing T, atIndex index: Int) -> JavaScriptValuesBuffer where T: ~Copyable {
+  internal consuming func set<T: JSIRepresentable>(value: borrowing T, atIndex index: Int) -> JavaScriptValuesBuffer
+  where T: ~Copyable {
     guard (0..<count).contains(index) else {
       FatalError.valuesBufferIndexOutRange(index: index, capacity: count)
     }
@@ -74,7 +72,8 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
   }
 
   @JavaScriptActor
-  public func map<T>(_ transform: @JavaScriptActor (_ value: JavaScriptValue, _ index: Int) throws -> T) rethrows -> [T] {
+  public func map<T>(_ transform: @JavaScriptActor (_ value: JavaScriptValue, _ index: Int) throws -> T) rethrows -> [T]
+  {
     var result: [T] = []
     result.reserveCapacity(count)
     for index in 0..<count {
@@ -85,9 +84,7 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
     return result
   }
 
-  /**
-   Allocates a new buffer of the same capacity with copies of `facebook.jsi.Value` it stores.
-   */
+  /// Allocates a new buffer of the same capacity with copies of `facebook.jsi.Value` it stores.
   @JavaScriptActor
   public func copy() -> JavaScriptValuesBuffer {
     let bufferCopy = JavaScriptValuesBuffer.copying(in: runtime, buffer: bufferPointer)
@@ -103,19 +100,18 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
 
   // MARK: - Allocation
 
-  /**
-   Allocates new values buffer with the given capacity. The buffer is in uninitialized state.
-   You must initialize all elements using `set(value:atIndex)` method.
-   */
+  /// Allocates new values buffer with the given capacity. The buffer is in uninitialized state.
+  /// You must initialize all elements using `set(value:atIndex)` method.
   public static func allocate(in runtime: JavaScriptRuntime, capacity: Int) -> JavaScriptValuesBuffer {
-    return JavaScriptValuesBuffer(runtime, buffer: UnsafeMutableBufferPointer<facebook.jsi.Value>.allocate(capacity: capacity), ownsMemory: true)
+    return JavaScriptValuesBuffer(
+      runtime, buffer: UnsafeMutableBufferPointer<facebook.jsi.Value>.allocate(capacity: capacity), ownsMemory: true)
   }
 
-  /**
-   Allocates new values buffer with the given JS representables.
-   Note that parameter packs still do not support non-copyable types so they need to be passed as `JavaScriptRef`.
-   */
-  public static func allocate<each T: JavaScriptRepresentable>(in runtime: JavaScriptRuntime, with values: repeat each T) -> JavaScriptValuesBuffer {
+  /// Allocates new values buffer with the given JS representables.
+  /// Note that parameter packs still do not support non-copyable types so they need to be passed as `JavaScriptRef`.
+  public static func allocate<each T: JavaScriptRepresentable>(
+    in runtime: JavaScriptRuntime, with values: repeat each T
+  ) -> JavaScriptValuesBuffer {
     // First we count parameters in a pack to find the proper buffer capacity. This is still the simplest way.
     var capacity = 0
     for _ in repeat each values {
@@ -138,7 +134,9 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
     return JavaScriptValuesBuffer(runtime, buffer: buffer, ownsMemory: true)
   }
 
-  internal static func copying(in runtime: JavaScriptRuntime, buffer: UnsafeMutableBufferPointer<facebook.jsi.Value>) -> UnsafeMutableBufferPointer<facebook.jsi.Value> {
+  internal static func copying(in runtime: JavaScriptRuntime, buffer: UnsafeMutableBufferPointer<facebook.jsi.Value>)
+    -> UnsafeMutableBufferPointer<facebook.jsi.Value>
+  {
     let copy = UnsafeMutableBufferPointer<facebook.jsi.Value>.allocate(capacity: buffer.count)
     for index in 0..<buffer.count {
       copy.initializeElement(at: index, to: facebook.jsi.Value(runtime.pointee, buffer[index]))
@@ -146,16 +144,15 @@ public struct JavaScriptValuesBuffer: JavaScriptType, ~Copyable {
     return copy
   }
 
-  /**
-   Allocates a new owning buffer holding a runtime-aware copy of each value's
-   underlying `facebook.jsi.Value`. The given `JavaScriptValue`s must all belong
-   to `runtime`; mixing runtimes will crash deep inside JSI.
-   */
+  /// Allocates a new owning buffer holding a runtime-aware copy of each value's
+  /// underlying `facebook.jsi.Value`. The given `JavaScriptValue`s must all belong
+  /// to `runtime`; mixing runtimes will crash deep inside JSI.
   @JavaScriptActor
   public static func copying(in runtime: JavaScriptRuntime, values: [JavaScriptValue]) -> JavaScriptValuesBuffer {
     let buffer = UnsafeMutableBufferPointer<facebook.jsi.Value>.allocate(capacity: values.count)
     for (index, value) in values.enumerated() {
-      assert(value.runtime === runtime, "JavaScriptValue belongs to a different runtime than the buffer being initialized")
+      assert(
+        value.runtime === runtime, "JavaScriptValue belongs to a different runtime than the buffer being initialized")
       buffer.initializeElement(at: index, to: facebook.jsi.Value(runtime.pointee, value.pointee))
     }
     return JavaScriptValuesBuffer(runtime, buffer: buffer, ownsMemory: true)