Enumerations

The following enumerations are available globally.

  • An enumeration that provides functionality for dynamic decoding of data. This can be used to decode data whose structure is not known at compile time.

    See more

    Declaration

    Swift

    public enum DynamicDecoder
  • An enumeration representing the types of file protection available.

    This enum provides different levels of file protection that can be applied to secure files. Each case corresponds to a specific file protection type and is represented as a String.

    • Conforms to:
      • CaseIterable: Allows iteration over all cases of the enum.
    See more

    Declaration

    Swift

    public enum FileProtectionType : String, CaseIterable

Query Operator

  • An enumeration representing various query operators that can be used to filter or match data in a query.

    Each case represents a specific type of operation that can be performed on the data.

    • Cases:
      • equal: Matches values that are equal to the specified value.
      • notEqual: Matches values that are not equal to the specified value.
      • range: Matches values that fall within the specified lower and upper bounds.
      • contains: Matches strings that contain the specified substring.
      • startsWith: Matches strings that start with the specified prefix.
      • endsWith: Matches strings that end with the specified suffix.
      • lessThan: Matches values that are less than the specified value.
      • lessThanOrEqual: Matches values that are less than or equal to the specified value.
      • greaterThan: Matches values that are greater than the specified value.
      • greaterThanOrEqual: Matches values that are greater than or equal to the specified value.
      • between: Matches values that fall inclusively between the specified lower and upper bounds.
      • in: Matches values that are contained within the specified array of values.
      • exists: Matches values that exist (non-nil).
      • notExists: Matches values that do not exist (nil).

    This enumeration conforms to CustomStringConvertible to provide a textual description of each operator.

    See more

    Declaration

    Swift

    public enum QueryOperator : CustomStringConvertible
  • An enumeration representing the available compression methods for data storage or transmission.

    • none: No compression is applied.
    • gzip: Uses the Gzip compression algorithm.
    • lzfse: Uses the LZFSE compression algorithm, optimized for speed and compression ratio.
    • lz4: Uses the LZ4 compression algorithm, optimized for very fast compression and decompression.

    This enum conforms to String, CaseIterable, and Codable protocols, allowing it to be represented as a string, iterated over all cases, and encoded/decoded.

    See more

    Declaration

    Swift

    public enum CompressionMethod : String, CaseIterable, Codable
  • An enumeration representing errors that can occur during compression or decompression operations.

    • compressionFailed: Indicates that the compression process failed.
    • decompressionFailed: Indicates that the decompression process failed.
    • unsupportedMethod: Indicates that the specified compression method is not supported.
    • zlibError(code: Int): Represents an error returned by the zlib library, with an associated error code.
    See more

    Declaration

    Swift

    public enum CompressionError : Error
  • An enumeration representing errors that can occur within the ShardManager.

    This enum conforms to the Error protocol, allowing instances of it to be thrown and caught as part of error handling in Swift.

    See more

    Declaration

    Swift

    public enum ShardManagerError : Error