@chilkat/react-native 11.6.1

package/src/specs/ZipCrc.nitro.ts

@@ -0,0 +1,229 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Calculate ZIP-compatible CRC32 values for files, bytes, strings, and streamed data.
+ *
+ * `ZipCrc` calculates the 32-bit CRC value used in ZIP file
+ * headers. It can compute CRC32 values for in-memory byte arrays,
+ * `BinData`, `StringBuilder` content, strings using a
+ * specified character encoding, and entire files. It also supports streaming
+ * CRC calculation, allowing applications to process large or incremental data
+ * in chunks without holding the full input in memory.
+ *
+ * **CRC32 for byte data**
+ *
+ * Use `CalculateCrc` to calculate a ZIP-style CRC32 value for
+ * an in-memory byte array.
+ *
+ * **BinData support**
+ *
+ * Use `CrcBd` when the input bytes are already stored in a
+ * `Chilkat.BinData` object.
+ *
+ * **String CRCs**
+ *
+ * Use `CrcString` or `CrcSb` to calculate CRC32 for
+ * text using a specific charset such as `utf-8`,
+ * `utf-16`, or `windows-1252`.
+ *
+ * **File CRCs**
+ *
+ * Use `FileCrc` to calculate the CRC32 of a file while streaming
+ * the file contents to keep memory usage small and constant.
+ *
+ * **Streaming calculation**
+ *
+ * Call `BeginStream`, add chunks with `MoreData`, and
+ * finish with `EndStream` when data arrives incrementally.
+ *
+ * **Hex formatting**
+ *
+ * Use `ToHex` to convert a 32-bit CRC integer into a readable
+ * hexadecimal string.
+ *
+ * **Common pattern:**
+ * Use `FileCrc` for files, `CalculateCrc` or
+ * `CrcBd` for binary data already in memory, and
+ * `CrcString` or `CrcSb` for text where the byte
+ * representation depends on a charset. For large or chunked input, initialize
+ * the CRC with `BeginStream`, feed each block with
+ * `MoreData`, and call `EndStream` to obtain the final
+ * CRC32 value.
+ *
+ * **ZIP compatibility note:**
+ * The CRC returned by this class is the same 32-bit CRC value that would appear
+ * in a ZIP file header for the same byte content. When calculating CRCs for
+ * strings, the selected charset matters because the CRC is computed over bytes,
+ * not abstract characters.
+ *
+ * Each `ZipCrc` instance owns a native Chilkat object. It is released when the JavaScript object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new ZipCrc()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link ZipCrc.abort} and assigning {@link ZipCrc.onPercentDone} / {@link ZipCrc.onProgressInfo}.
+ */
+export interface ZipCrc extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Provides a way to calculate a CRC by streaming the data a chunk at a time. An application would
+   * start by calling BeginStream. Then it would add data by calling MoreData for each additional
+   * chunk. After the last chunk has been processed, the EndStream method is called to return the
+   * CRC.
+   */
+  beginStream(): void
+
+  /**
+   * Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple
+   * calls to MoreData.
+   */
+  endStream(): number
+
+  /**
+   * Calculates the CRC32 of a file. The data contained in the file is streamed for the calculation
+   * to keep the memory footprint small and constant. Returns the CRC32 of the file.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link ZipCrc.fileCrcAsync}.
+   */
+  fileCrc(path: string): number
+
+  /**
+   * Asynchronous form of {@link ZipCrc.fileCrc}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link ZipCrc.abort} (which cancels it) and the {@link ZipCrc.onPercentDone} /
+   * {@link ZipCrc.onProgressInfo} callbacks, which report progress while it runs.
+   */
+  fileCrcAsync(path: string): Promise<number>
+
+  /**
+   * Converts a 32-bit integer to a hex string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link ZipCrc.lastErrorText}.
+   */
+  toHex(crc: number): string
+
+  /**
+   * Calculates a CRC32 for a string. The `charset` is the byte representation to be used for the
+   * `str` when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of
+   * the character encodings (charsets) listed at the link below.
+   */
+  crcString(str: string, charset: string): number
+
+  /**
+   * Calculates a CRC32 for the string contained in `sb`. The `charset` is the byte representation
+   * to be used for the `sb` when calculating the CRC32. It can be utf-8, utf-16, windows-1252,
+   * iso-8859-1, or any of the character encodings (charsets) listed at the link below.
+   */
+  crcSb(sb: StringBuilder, charset: string): number
+
+  /**
+   * Calculates a CRC32 for the bytes contained in `bd`.
+   */
+  crcBd(bd: BinData): number
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link ZipCrc.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}