Protocol

StringProtocol

A type that can represent a string as a collection of characters.

Declaration

protocol StringProtocol where Self.Element == Character, Self.Index == String.Index, Self.StringInterpolation == DefaultStringInterpolation, Self.SubSequence : StringProtocol

Overview

Do not declare new conformances to StringProtocol. Only the String and Substring types in the standard library are valid conforming types.

Topics

Associated Types

associatedtype SubSequence

Required.

associatedtype UTF16View

Required.

associatedtype UTF8View

Required.

associatedtype UnicodeScalarView

Required.

Initializers

init(cString: UnsafePointer<CChar>)

Creates a string from the null-terminated, UTF-8 encoded sequence of bytes at the given pointer.

Required.

init<C, Encoding>(decoding: C, as: Encoding.Type)

Creates a string from the given Unicode code units in the specified encoding.

Required.

init<Encoding>(decodingCString: UnsafePointer<Encoding.CodeUnit>, as: Encoding.Type)

Creates a string from the null-terminated sequence of bytes at the given pointer.

Required.

Instance Properties

var capitalized: String
var decomposedStringWithCanonicalMapping: String
var decomposedStringWithCompatibilityMapping: String
var fastestEncoding: String.Encoding
var hash: Int
var localizedCapitalized: String
var localizedLowercase: String
var localizedUppercase: String
var precomposedStringWithCanonicalMapping: String
var precomposedStringWithCompatibilityMapping: String
var removingPercentEncoding: String?
var smallestEncoding: String.Encoding
var unicodeScalars: Self.UnicodeScalarView

Required.

var utf16: Self.UTF16View

Required.

var utf8: Self.UTF8View

Required.

Instance Methods

func addingPercentEncoding(withAllowedCharacters: CharacterSet) -> String?
func appending<T>(T) -> String
func appendingFormat<T>(T, CVarArg...) -> String
func applyingTransform(StringTransform, reverse: Bool) -> String?
func cString(using: String.Encoding) -> [CChar]?
func canBeConverted(to: String.Encoding) -> Bool
func capitalized(with: Locale?) -> String
func caseInsensitiveCompare<T>(T) -> ComparisonResult
func commonPrefix<T>(with: T, options: String.CompareOptions) -> String
func compare<T>(T, options: String.CompareOptions, range: Range<Self.Index>?, locale: Locale?) -> ComparisonResult
func completePath(into: UnsafeMutablePointer<String>?, caseSensitive: Bool, matchesInto: UnsafeMutablePointer<[String]>?, filterTypes: [String]?) -> Int
func components(separatedBy: CharacterSet) -> [String]
func components<T>(separatedBy: T) -> [String]
func contains<T>(T) -> Bool
func data(using: String.Encoding, allowLossyConversion: Bool) -> Data?
func enumerateLines(invoking: (String, inout Bool) -> Void)
func enumerateLinguisticTags<T, R>(in: R, scheme: T, options: NSLinguisticTagger.Options, orthography: NSOrthography?, invoking: (String, Range<Self.Index>, Range<Self.Index>, inout Bool) -> Void)
func enumerateSubstrings<R>(in: R, options: String.EnumerationOptions, (String?, Range<Self.Index>, Range<Self.Index>, inout Bool) -> Void)
func folding(options: String.CompareOptions, locale: Locale?) -> String
func getBytes<R>(inout [UInt8], maxLength: Int, usedLength: UnsafeMutablePointer<Int>, encoding: String.Encoding, options: String.EncodingConversionOptions, range: R, remaining: UnsafeMutablePointer<Range<Self.Index>>) -> Bool
func getCString(inout [CChar], maxLength: Int, encoding: String.Encoding) -> Bool
func getLineStart<R>(UnsafeMutablePointer<Self.Index>, end: UnsafeMutablePointer<Self.Index>, contentsEnd: UnsafeMutablePointer<Self.Index>, for: R)
func getParagraphStart<R>(UnsafeMutablePointer<Self.Index>, end: UnsafeMutablePointer<Self.Index>, contentsEnd: UnsafeMutablePointer<Self.Index>, for: R)
func hasPrefix(String) -> Bool

Required. Default implementation provided.

func hasSuffix(String) -> Bool

Required. Default implementation provided.

func lengthOfBytes(using: String.Encoding) -> Int
func lineRange<R>(for: R) -> Range<Self.Index>
func linguisticTags<T, R>(in: R, scheme: T, options: NSLinguisticTagger.Options, orthography: NSOrthography?, tokenRanges: UnsafeMutablePointer<[Range<Self.Index>]>?) -> [String]
func localizedCaseInsensitiveCompare<T>(T) -> ComparisonResult
func localizedCaseInsensitiveContains<T>(T) -> Bool
func localizedCompare<T>(T) -> ComparisonResult
func localizedStandardCompare<T>(T) -> ComparisonResult
func localizedStandardContains<T>(T) -> Bool
func localizedStandardRange<T>(of: T) -> Range<Self.Index>?
func lowercased() -> String

Required.

func lowercased(with: Locale?) -> String
func maximumLengthOfBytes(using: String.Encoding) -> Int
func padding<T>(toLength: Int, withPad: T, startingAt: Int) -> String
func paragraphRange<R>(for: R) -> Range<Self.Index>
func propertyList() -> Any
func propertyListFromStringsFileFormat() -> [String : String]
func range<T>(of: T, options: String.CompareOptions, range: Range<Self.Index>?, locale: Locale?) -> Range<Self.Index>?
func rangeOfCharacter(from: CharacterSet, options: String.CompareOptions, range: Range<Self.Index>?) -> Range<Self.Index>?
func rangeOfComposedCharacterSequence(at: Self.Index) -> Range<Self.Index>
func rangeOfComposedCharacterSequences<R>(for: R) -> Range<Self.Index>
func replacingCharacters<T, R>(in: R, with: T) -> String
func replacingOccurrences<Target, Replacement>(of: Target, with: Replacement, options: String.CompareOptions, range: Range<Self.Index>?) -> String
func substring(from: Self.Index) -> StringDeprecated
func substring(to: Self.Index) -> StringDeprecated
func substring(with: Range<Self.Index>) -> StringDeprecated
func trimmingCharacters(in: CharacterSet) -> String
func uppercased() -> String

Required.

func uppercased(with: Locale?) -> String
func withCString<Result>((UnsafePointer<CChar>) -> Result) -> Result

Calls the given closure with a pointer to the contents of the string, represented as a null-terminated sequence of UTF-8 code units.

Required.

func withCString<Result, Encoding>(encodedAs: Encoding.Type, (UnsafePointer<Encoding.CodeUnit>) -> Result) -> Result

Calls the given closure with a pointer to the contents of the string, represented as a null-terminated sequence of code units.

Required.

func write(to: URL, atomically: Bool, encoding: String.Encoding)
func write<T>(toFile: T, atomically: Bool, encoding: String.Encoding)

Operator Functions

static func != <RHS>(Self, RHS) -> Bool
static func == <RHS>(Self, RHS) -> Bool

Returns a Boolean value indicating whether two values are equal.

Relationships

Inherits From

Conforming Types

See Also

Related String Types

struct Substring

A slice of a string.

struct String.Index

A position of a character or code unit in a string.

struct String.UnicodeScalarView

A view of a string’s contents as a collection of Unicode scalar values.

struct String.UTF16View

A view of a string’s contents as a collection of UTF-16 code units.

struct String.UTF8View

A view of a string’s contents as a collection of UTF-8 code units.

struct String.Iterator

A type that provides the collection’s iteration interface and encapsulates its iteration state.

struct String.Encoding