Instance Method

remove(at:)

Removes and returns the character at the specified position.

Declaration

@discardableResult mutating func remove(at i: String.Index) -> Character

Parameters

i

The position of the character to remove. i must be a valid index of the string that is not equal to the string’s end index.

Return Value

The character that was removed.

Discussion

All the elements following i are moved to close the gap. This example removes the hyphen from the middle of a string.

var nonempty = "non-empty"
if let i = nonempty.characters.index(of: "-") {
    nonempty.remove(at: i)
}
print(nonempty)
// Prints "nonempty"

Calling this method invalidates any existing indices for use with this string.