kinesis4cats.models.HashKeyRange.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kinesis4cats-shared_native0.4_2.12 Show documentation

Common shared utilities

There is a newer version: 0.0.32

Show newest version

/*
 * Copyright 2023-2023 etspaceman
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package kinesis4cats.models

/** Helper class representing the hash key range for a shard
  *
  * @param endingHashKey
  *   Max hash key for the shard
  * @param startingHashKey
  *   Min hash key for the shard
  */
final case class HashKeyRange(endingHashKey: BigInt, startingHashKey: BigInt) {

  /** If true, provided hash key is within the shard's hash key range
    *
    * @param hashKey
    *   Hash key to compare
    * @return
    *   true if within hash key range, false if not
    */
  def isBetween(hashKey: BigInt): Boolean =
    hashKey >= startingHashKey && hashKey <= endingHashKey
}