semver/io.github.z4kn4fein.semver.constraints

Package-level declarations

Types

@Serializable(with = ConstraintSerializer::class)

This class describes a semantic version constraint. It provides ability to verify whether a version satisfies one or more conditions within a constraint.

ConstraintFormatException

class ConstraintFormatException(message: String) : Exception

Constraint throws this exception when the constraint parsing fails due to an invalid format.

ConstraintSerializer

object ConstraintSerializer : KSerializer<Constraint>

Built-in kotlinx.serialization serializer that encodes and decodes Constraint as its string representation.

Functions

satisfiedBy

infix fun Constraint.satisfiedBy(version: Version): Boolean

Determines whether a Constraint is satisfied by a Version or not.

satisfiedByAll

infix fun Constraint.satisfiedByAll(versions: Iterable<Version>): Boolean

Determines whether a Constraint is satisfied by each Version in a collection or not.

satisfiedByAny

infix fun Constraint.satisfiedByAny(versions: Iterable<Version>): Boolean

Determines whether a Constraint is satisfied by at least one Version in a collection or not.

toConstraint

fun String.toConstraint(): Constraint

Parses the string as a Constraint and returns the result or throws a ConstraintFormatException if the string is not a valid representation of a constraint.

toConstraintOrNull

fun String.toConstraintOrNull(): Constraint?

Parses the string as a Constraint and returns the result or null if the string is not a valid representation of a constraint.