@chilkat/react-native 11.6.1

package/src/specs/BinData.nitro.ts

@@ -0,0 +1,470 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Build, transform, encode, decode, inspect, and save binary data.
+ *
+ * `BinData` is a general-purpose mutable byte container used
+ * throughout Chilkat for working with binary content in memory. It can load
+ * bytes from files, byte arrays, strings, and encoded text; append additional
+ * data in many forms; retrieve content as raw bytes, chunks, text, or encoded
+ * strings; compute hashes; convert character encodings; validate UTF-8; remove
+ * byte ranges; and write the final result to files.
+ *
+ * **Load binary content**
+ *
+ * Load data from files, byte arrays, strings, encoded strings, or other
+ * Chilkat objects that produce binary output.
+ *
+ * **Append and build data**
+ *
+ * Append bytes, strings, integers, BOMs, counted strings, padded fields,
+ * encoded data, and other `BinData` objects.
+ *
+ * **Encode and decode**
+ *
+ * Convert binary data to and from text encodings such as Base64, hex, URL
+ * encoding, and other supported binary encodings.
+ *
+ * **Text and charset handling**
+ *
+ * Interpret bytes as text, append strings using a specified charset,
+ * convert character encodings, and validate UTF-8 content.
+ *
+ * **Inspect and modify bytes**
+ *
+ * Get byte counts, extract chunks, remove ranges, compare data, and work
+ * with specific portions of a binary buffer.
+ *
+ * **Hash and save output**
+ *
+ * Compute hashes for the contained data and write the resulting bytes to
+ * files or pass them to other Chilkat classes.
+ *
+ * **Common pattern:**
+ * Load or append binary data, perform any needed encoding, decoding, hashing,
+ * charset conversion, or byte-level edits, then retrieve the result as bytes,
+ * text, an encoded string, or a file. Use `BinData` whenever a
+ * Chilkat method needs a mutable in-memory binary buffer.
+ *
+ * For an extended overview, see
+ * [BinData Class Overview](https://www.chilkatsoft.com/bindata_class_overview.asp).
+ *
+ * Each `BinData` 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 BinData()`.
+ */
+export interface BinData 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
+
+  /**
+   * The number of bytes contained within the object.
+   *
+   * This property is read-only.
+   */
+  readonly numBytes: number
+
+  // ---- Methods ----
+
+  /**
+   * Loads binary data from an encoded string, replacing the current contents, if any. The
+   * `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for
+   * quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat
+   * Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  loadEncoded(encData: string, encoding: string): void
+
+  /**
+   * Retrieves the binary data as an encoded string. The `encoding` may be `Base64`, `modBase64`,
+   * `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`,
+   * or any of the encodings found at [Chilkat Binary Encodings
+   * List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getEncoded(encoding: string): string
+
+  /**
+   * Appends encoded binary data to the current data. The `encoding` may be `Base64`, `modBase64`,
+   * `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`,
+   * or any of the encodings found at [Chilkat Binary Encodings
+   * List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendEncoded(encData: string, encoding: string): void
+
+  /**
+   * Clears the contents.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  clear(): void
+
+  /**
+   * Loads data from a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  loadFile(path: string): void
+
+  /**
+   * Retrieves a chunk of the binary data and returns it in encoded form. The `encoding` may be
+   * `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for
+   * url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings
+   * List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getEncodedChunk(offset: number, numBytes: number, encoding: string): string
+
+  /**
+   * Removes a chunk of bytes from the binary data.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  removeChunk(offset: number, numBytes: number): void
+
+  /**
+   * Writes the contents to a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  writeFile(path: string): void
+
+  /**
+   * Writes the encoded data to a StringBuilder. The `encoding` may be `Base64`, `modBase64`,
+   * `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`,
+   * or any of the encodings found at [Chilkat Binary Encodings
+   * List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getEncodedSb(encoding: string, sb: StringBuilder): void
+
+  /**
+   * Appends the contents of another BinData to this object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendBd(binData: BinData): void
+
+  /**
+   * Appends a string to this object. (This does not append the BOM. If a BOM is required, the
+   * AppendBom method can be called to append the appropriate BOM.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendString(str: string, charset: string): void
+
+  /**
+   * Appends the contents of a StringBuilder to this object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendSb(sb: StringBuilder, charset: string): void
+
+  /**
+   * Appends the appropriate BOM (byte order mark), also known as a `preamble`, for the given
+   * charset. If the `charset` has no defined BOM, then nothing is appended. An application would
+   * typically call this to append the utf-8, utf-16, or utf-32 BOM.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendBom(charset: string): void
+
+  /**
+   * Decodes the contents of `sb` and appends the decoded bytes to this object. The `encoding` may
+   * be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL`
+   * (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings
+   * List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendEncodedSb(sb: StringBuilder, encoding: string): void
+
+  /**
+   * Return `true` if the contents of this object equals the contents of `binData`.
+   */
+  contentsEqual(binData: BinData): boolean
+
+  /**
+   * Securely clears the contents by writing 0 bytes to the memory prior to deallocating the
+   * internal memory.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  secureClear(): void
+
+  /**
+   * Interprets the bytes according to `charset` and returns the string. The `charset` can be
+   * `utf-8`, `utf-16`, `ansi`, `iso-8859-*`, `windows-125*`, or any of the supported character
+   * encodings listed in the link below.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getString(charset: string): string
+
+  /**
+   * Appends a single byte.  The `byteValue` should be a value from 0 to 255.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendByte(byteValue: number): void
+
+  /**
+   * Appends a 32-bit integer (4 bytes). If `littleEndian` is `true`, then the integer bytes are
+   * appended in little-endian byte order, otherwise big-endian byte order is used.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendInt4(value: number, littleEndian: boolean): void
+
+  /**
+   * Appends a 16-bit integer (2 bytes). If `littleEndian` is `true`, then the integer bytes are
+   * appended in little-endian byte order, otherwise big-endian byte order is used.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendInt2(value: number, littleEndian: boolean): void
+
+  /**
+   * Appends a string to this object, padded to the `fieldLen` with NULL or SPACE chars. If
+   * `padWithSpace` is `true`, then SPACE chars are used and the string is not null-terminated. If
+   * `fieldLen` is `false`, then null bytes are used. The `charset` controls the byte representation
+   * to use, such as `utf-8`.
+   *
+   * Note: This call will always append a total number of bytes equal to `fieldLen`. If the `str` is
+   * longer than `fieldLen`, the method returns `false` to indicate failure and nothing is appended.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendPadded(str: string, charset: string, padWithSpace: boolean, fieldLen: number): void
+
+  /**
+   * Return the index where the first occurrence of `str` is found. Return -1 if not found. The
+   * `startIdx` indicates the byte index where the search begins. The `charset` specifies the byte
+   * representation of `str` that is to be searched. For example, it can be `utf-8`, `windows-1252`,
+   * `ansi`, `utf-16`, etc.
+   */
+  findString(str: string, startIdx: number, charset: string): number
+
+  /**
+   * Returns `numBytes` bytes starting at `startIdx`. The bytes are interpreted according to
+   * `charset` (for example, `utf-8`, `ansi`, `utf-16`, `windows-1252`, etc.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getTextChunk(startIdx: number, numBytes: number, charset: string): string
+
+  /**
+   * Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte
+   * ordering at the given index.
+   */
+  getInt2(index: number, littleEndian: boolean): number
+
+  /**
+   * Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte
+   * ordering at the given index.
+   */
+  getInt4(index: number, littleEndian: boolean): number
+
+  /**
+   * Returns the value of the 16-bit unsigned integer stored in big-endian or little-endian byte
+   * ordering at the given index.
+   */
+  getUInt2(index: number, littleEndian: boolean): number
+
+  /**
+   * Returns the value of the 32-bit unsigned integer stored in big-endian or little-endian byte
+   * ordering at the given index.
+   */
+  getUInt4(index: number, littleEndian: boolean): number
+
+  /**
+   * Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0
+   * in `value`.
+   */
+  removeByteVal(value: number): void
+
+  /**
+   * Appends the contents of this object to a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  writeAppendFile(path: string): void
+
+  /**
+   * Returns the hash of the contents of this object. The `algorithm` is the hash algorithm, and can
+   * be `sha1`, `sha256`, `sha384`, `sha512`, `sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `md2`,
+   * `md5`, `ripemd128`, `ripemd160`,`ripemd256`, or `ripemd320`.
+   * The `encoding` can be `base64`, `modBase64`, `base64Url`, `base32`, `base58`, `qp` (for
+   * quoted-printable), `url` (for url-encoding), `hex`, `hexLower`, or any of the encodings found
+   * at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  getHash(algorithm: string, encoding: string): string
+
+  /**
+   * Appends a byte count followed by the string in the desired character encoding, such as `utf-8`.
+   * The `numCountBytes` is the size in bytes of the integer to represent the byte count. If 0, then
+   * a minimal number of bytes is used. If `bigEndian` is `true`, the byte count is appended in big
+   * endian byte ordering, otherwise little-ending byte ordering. The `str` is the string to be
+   * appended. The `charset` is the character encoding, such as `utf-8`, `utf-16`, `windows-1252`,
+   * etc.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendCountedString(numCountBytes: number, bigEndian: boolean, str: string, charset: string): void
+
+  /**
+   * Returns the value of the byte at the given `index`. The returned value is an integer from 0 to
+   * 255.
+   */
+  getByte(index: number): number
+
+  /**
+   * Returns `true` if this object contains valid utf-8 byte sequences. Any invalid byte sequence
+   * that is not valid utf-8 will cause this function to return `false`.
+   */
+  isValidUtf8(): boolean
+
+  /**
+   * Does either 16-bit or 32-bit byte swapping of the entire contents. If `size` equals 16, then
+   * swaps in 2 bytes (e.g., 0x1234 → 0x3412). If `size` equals 32, then swaps 4 bytes (e.g.,
+   * 0x12345678 → 0x78563412)
+   */
+  byteSwap(size: number): void
+
+  /**
+   * This method converts the character encoding of an object's contents from one format to another,
+   * such as from Windows-1252 to UTF-8. The `allOrNone` parameter determines error handling for
+   * unrepresentable bytes. If `allOrNone` is `true`, the object's contents remain unchanged when
+   * errors occur. If `false`, error bytes are discarded. The method returns `true` if successful
+   * and `false` if errors occur.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  charsetConvert(fromCharset: string, toCharset: string, allOrNone: boolean): void
+
+  /**
+   * Appends binary data to the current contents, if any.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link BinData.lastErrorText}.
+   */
+  appendData(data: ArrayBuffer): void
+
+  /**
+   * Returns a copy of the binary data contained in this object. Returns an empty ArrayBuffer when
+   * the object is empty.
+   */
+  getData(): ArrayBuffer
+
+  /**
+   * Returns a copy of `numBytes` bytes of the binary data starting at `offset`. The range is
+   * clamped to the data actually present, so the result may be shorter than requested.
+   */
+  getDataChunk(offset: number, numBytes: number): ArrayBuffer
+}