Structureswift 6.0.1Swift
ClosedRange
An interval from a lower bound up to, and including, an upper bound.
@frozen struct ClosedRange<Bound> where Bound : ComparableYou create a ClosedRange instance by using the closed range operator (...).
let throughFive = 0...5A ClosedRange instance contains both its lower bound and its upper bound.
throughFive.contains(3)
// true
throughFive.contains(10)
// false
throughFive.contains(5)
// trueBecause a closed range includes its upper bound, a closed range whose lower bound is equal to the upper bound contains that value. Therefore, a ClosedRange instance cannot represent an empty range.
let zeroInclusive = 0...0
zeroInclusive.contains(0)
// true
zeroInclusive.isEmpty
// falseUsing a Closed Range as a Collection of Consecutive Values
When a closed range uses integers as its lower and upper bounds, or any other type that conforms to the Strideable protocol with an integer stride, you can use that range in a for-in loop or with any sequence or collection method. The elements of the range are the consecutive values from its lower bound up to, and including, its upper bound.
for n in 3...5 {
print(n)
}
// Prints "3"
// Prints "4"
// Prints "5"Because floating-point types such as Float and Double are their own Stride types, they cannot be used as the bounds of a countable range. If you need to iterate over consecutive floating-point values, see the stride(from:through:by:) function.
Citizens in Swift
Type members
init(uncheckedBounds: (lower: Bound, upper: Bound)) Creates an instance with the given bounds.
Instance members
let lowerBound: BoundThe range’s lower bound.
let upperBound: BoundThe range’s upper bound.
Citizens in Swift
where Bound:Encodable, Bound:ComparableConformances
protocol EncodableA type that can encode itself to an external representation.
Instance members
Citizens in Swift
where Bound:Hashable, Bound:ComparableConformances
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.
Instance members
Citizens in Swift
where Bound:ComparableConformances
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol RangeExpression<Bound>A type that can be used to slice a collection.
Type members
static func == (lhs: ClosedRange<Bound>, rhs: ClosedRange<Bound>) -> Bool Returns a Boolean value indicating whether two ranges are equal.
Instance members
var customMirror: Mirrorvar debugDescription: StringA textual representation of the range, suitable for debugging.
var description: StringA textual representation of the range.
var isEmpty: BoolA Boolean value indicating whether the range contains no elements.
func clamped(to: ClosedRange<Bound>) -> ClosedRange<Bound> Returns a copy of this range clamped to the given limiting range.
func contains(Bound) -> Bool Returns a Boolean value indicating whether the given element is contained within the range.
func overlaps(ClosedRange<Bound>) -> Bool func overlaps(Range<Bound>) -> Bool func relative<C>(to: C) -> Range<Bound>
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func ~= (pattern: Self, value: Self.Bound) -> Bool Returns a Boolean value indicating whether a value is included in a range.
Citizens in Swift
where Bound:Comparable, Bound:DecodableConformances
protocol DecodableA type that can decode itself from an external representation.
Type members
Citizens in Swift
where Bound:Comparable, Bound:SendableConformances
Citizens in Swift
where Bound:Strideable, Bound.Stride:SignedIntegerConformances
protocol BidirectionalCollection<Element>A collection that supports backward as well as forward traversal.
protocol Collection<Element>A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol RandomAccessCollection<Element>A collection that supports efficient random-access index traversal.
protocol Sequence<Element>A type that provides sequential, iterated access to its elements.
Types
Typealiases
Type members
init(Range<Bound>) Creates an instance equivalent to the given
Range.
Show obsolete interfaces (1)
Hide obsolete interfaces
init(ClosedRange<Bound>) Now that Range is conditionally a collection when Bound: Strideable, CountableRange is no longer needed. This is a deprecated initializer for any remaining uses of Range(countableRange).
Instance members
var endIndex: ClosedRange<Bound>.IndexThe range’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var startIndex: ClosedRange<Bound>.IndexThe position of the first element in the range.
subscript(Range<ClosedRange<Bound>.Index>) -> Slice<ClosedRange<Bound>> subscript(ClosedRange<Bound>.Index) -> Bound Accesses the element at specified position.
func distance(from: ClosedRange<Bound>.Index, to: ClosedRange<Bound>.Index) -> Int func index(ClosedRange<Bound>.Index, offsetBy: Int) -> ClosedRange<Bound>.Index func index(after: ClosedRange<Bound>.Index) -> ClosedRange<Bound>.Index func index(before: ClosedRange<Bound>.Index) -> ClosedRange<Bound>.Index
Extension in Testing
where Bound:ComparableConformances
protocol CustomTestStringConvertibleA protocol describing types with a custom string representation when presented as part of a test’s output.
Instance members
Extension in Testing
where Bound == IntConformances
Show system interfaces (1)
Hide system interfaces
protocol ExpectedCountA protocol that describes a range expression that can be used with
confirmation(_:expectedCount:sourceLocation:_:).