String

struct String
  • Mechanica

    Returns the length of the String.

    Declaration

    Swift

    public var length: Int
  • Mechanica

    Reverse self.

    Declaration

    Swift

    public mutating func reverse()
  • Mechanica

    Returns a new reversed String. Shorthand for self.characters.reverse().

    Declaration

    Swift

    public func reversed() -> String
  • Mechanica

    Returns true if self starts with a given prefix.

    Declaration

    Swift

    public func starts(with prefix: String, caseSensitive: Bool = true) -> Bool
  • Mechanica

    Returns true if self ends with a given suffix.

    Declaration

    Swift

    public func ends(with suffix: String, caseSensitive: Bool = true) -> Bool
  • Mechanica

    Checks if self contains a String.

    Declaration

    Swift

    public func contains(_ string: String, caseSensitive: Bool) -> Bool

    Parameters

    string

    String to match.

    caseSensitive

    Search option: for case-sensitive, false for case-insensitive. (if this function is equivalent to self.contains(...))

    Return Value

    if contains match, otherwise false.

  • Mechanica

    Checks if if all the characters in the string belong to a specific CharacterSet.

    Declaration

    Swift

    public func containsCharacters(in characterSet: CharacterSet) -> Bool

    Parameters

    characterSet

    The CharacterSet used to test the string.

    Return Value

    if all the characters in the string belong to the CharacterSet, otherwise false.

  • Mechanica

    Returns a new string in which all occurrences of a target are replaced by another given string.

    Declaration

    Swift

    public func replace(_ target: String, with replacement: String, caseSensitive: Bool = true) -> String

    Parameters

    target

    target string

    replacement

    replacement string

    caseSensitive

    *true* (default) for a case-sensitive replacemente

  • Mechanica

    Generates a new random alphanumeric string of a given length (default 8).

    Declaration

    Swift

    public static func random(length: UInt32 = 8) -> String
  • Mechanica

    Removes spaces and new lines from both ends of `self.

    Declaration

    Swift

    public mutating func trim()
  • Mechanica*

    Returns a new String made by removing spaces and new lines from both ends.

    Declaration

    Swift

    public func trimmed() -> String
  • Mechanica*

    Strips the specified characters from the beginning of self.

    Declaration

    Swift

    public func trimmedLeft(characterSet set: CharacterSet = .whitespacesAndNewlines) -> String

    Parameters

    set

    characters to strip

    Return Value

    stripped string

  • Mechanica*

    Strips the specified characters from the end of self.

    Declaration

    Swift

    public func trimmedRight(characterSet set: CharacterSet = .whitespacesAndNewlines) -> String

    Parameters

    set

    characters to strip

    Return Value

    stripped string

  • Mechanica

    Produces a new string with the first character of the first word changed to the corresponding uppercase value.

    Declaration

    Swift

    public func capitalizedFirstCharacter() -> String
  • Mechanica

    Produces a new string with the first character of the first word changed to the corresponding uppercase value.

    Declaration

    Swift

    public func decapitalizedFirstCharacter() -> String
  • Mechanica

    Returns a new string containing the first character of the String.

    Declaration

    Swift

    public var first: String
  • Mechanica

    Returns a new string containing the last character of the String.

    Declaration

    Swift

    public var last: String
  • Mechanica*

    Returns a substring, up to maxLength in length, containing the initial elements of the String.

    Warning

    If maxLength exceeds self.count, the result contains all the elements of self.

    Declaration

    Swift

    public func prefix(maxLength: Int) -> String

    Parameters

    maxLength

    substring max lenght

  • Mechanica*

    Returns a slice, up to maxLength in length, containing the final elements of String.

    Warning

    If maxLength exceeds String character count, the result contains all the elements of String.

    Declaration

    Swift

    public func suffix(maxLength: Int) -> String

    Parameters

    maxLength

    substring max lenght

  • Mechanica

    Returns a new String containing the characters of the String from the one at a given position to the end.

    Example:

    "hello".removingPrefix(upToPosition: 1) // "ello"
    

    Declaration

    Swift

    public func removingPrefix(upToPosition: Int = 1) -> String

    Parameters

    upToPosition

    position (included) up to which remove the prefix.

  • Mechanica

    Returns a new String removing the spcified prefix (if the string has it).

    Example:

    "hello".removingPrefix("hel") // "lo"
    

    Declaration

    Swift

    public func removingPrefix(_ prefix: String) -> String

    Parameters

    prefix

    prefix to be removed.

  • Mechanica

    Returns a new String containing the characters of the String up to, but not including, the one at a given position.

    Example:

    "hello".removingSuffix(fromPosition: 1) == "hell"
    

    Declaration

    Swift

    public func removingSuffix(fromPosition: Int = 1) -> String

    Parameters

    fromPosition

    position (included) from which remove the suffix

  • Mechanica

    Returns a new String removing the spcified suffix (if the string has it).

    Example:

    "hello".removingSuffix("0") // "hell"
    

    Declaration

    Swift

    public func removingSuffix(_ suffix: String) -> String

    Parameters

    prefix

    prefix to be removed.

  • Mechanica*

    Returns a new String removing the characters in the given set.

    Declaration

    Swift

    public func removingCharacters(in set: CharacterSet) -> String
  • Mechanica*

    Truncates the String to the given length (number of characters) and appends optional trailing string if longer. The default trailing is the ellipsis (…). - parameter length: number of characters after which the String is truncated - parameter trailing: optional trailing string

    Declaration

    Swift

    public func truncate(at length: Int, withTrailing trailing: String? = "…") -> String

    Parameters

    length

    number of characters after which the String is truncated

    trailing

    optional trailing string

  • Mechanica

    Condenses all white spaces repetitions in a single white space. White space at the beginning or ending of the String are trimmed out.

    Example:

    let aString = "test    too many    spaces"
    aString.removeExcessiveSpaces //test too many spaces
    

    Declaration

    Swift

    public func condensingExcessiveSpaces() -> String

    Return Value

    A new string where all white spaces repetitions are replaced with a single white space.

  • Mechanica*

    Condenses all white spaces and new lines repetitions in a single white space. White space and new lines at the beginning or ending of the String are trimmed out.

    Declaration

    Swift

    public func condensingExcessiveSpacesAndNewlines() -> String

    Return Value

    A new string where all white spaces and new lines repetitions are replaced with a single white space.

  • Mechanica

    Returns a new string in which the characters in a specified CountableClosedRange range of the String are replaced by a given string.

    Declaration

    Swift

    public func replacingCharacters(in range: CountableClosedRange<Int>, with replacement: String) -> String
  • Mechanica

    Returns a new string in which the characters in a specified CountableRange range of the String are replaced by a given string.

    Declaration

    Swift

    public func replacingCharacters(in range: CountableRange<Int>, with replacement: String) -> String
  • Mechanica

    Produces a camel cased version of the String.

    Example:

    let string = "HelloWorld"
    print(string.camelCased()) // "helloWorld"
    

    Declaration

    Swift

    public func camelCased() -> String

    Return Value

    A camel cased copy of the String.

  • Mechanica

    Produces the kebab cased version of the String.

    Example:

    let string = "Hello World"
    print(string.kebabCased()) // "-Hello-World-"
    

    Declaration

    Swift

    public func kebabCased() -> String

    Return Value

    The kebab cased copy of the String.

  • Mechanica

    Produces a pascal cased version of the String.

    Example:

    let string = "HELLO WORLD"
    print(string.pascalCased()) // "HelloWorld"
    

    Declaration

    Swift

    public func pascalCased() -> String

    Return Value

    A pascal cased copy of the String.

  • Mechanica

    Produces the slug version of the String.

    Example:

    let string = "Hello World"
    print(string.slugCased()) // "Hello-World"
    

    Declaration

    Swift

    public func slugCased() -> String

    Return Value

    The slug copy of the String.

  • Mechanica

    Produces the snake cased version of the String.

    Example:

    let string = "hello world"
    print(string.snakeCased())
    // Prints "hello_world"
    

    Declaration

    Swift

    public func snakeCased() -> String

    Return Value

    The slug copy of the String.

  • Mechanica

    Produces the swap cased version of the String.

    Example:

    let string = "Hello World"
    print(string.swapCased()) // "hELLO wORLD"
    

    Declaration

    Swift

    public func swapCased() -> String

    Return Value

    The swap cased copy of the String.

  • Mechanica

    Declaration

    Swift

    public func ranges(matching pattern: String, options: NSRegularExpression.Options = []) -> [Range<String.Index>]

    Parameters

    pattern

    a regular expression pattern.

    options

    a list of NSRegularExpression.Options.

    Return Value

    returns a list of matched ranges for self or empy. Defaults to [].

  • Mechanica

    Declaration

    Swift

    public func firstRange(matching pattern: String, options: NSRegularExpression.Options = []) -> Range<String.Index>?

    Parameters

    pattern

    a regular expression pattern.

    options

    a list of NSRegularExpression.Options.

    Return Value

    returns a the first matched range for self or nil.

  • Mechanica

    Creates a new string representing the given string repeated the specified number of times.

    Declaration

    Swift

    public static func * (lhs: String, rhs: Int) -> String
  • Mechanica

    Creates a new string representing the given string repeated the specified number of times.

    Declaration

    Swift

    public static func * (lhs: Int, rhs: String) -> String
  • Mechanica

    Return a Bool value by parsing self.

    Declaration

    Swift

    public var bool: Bool?
  • Mechanica

    Returns a Double value by parsing self.

    Declaration

    Swift

    public var double: Double?
  • Mechanica

    Returns a Float value by parsing self.

    Declaration

    Swift

    public var float: Float?
  • Mechanica

    Returns a Float32 value by parsing self.

    Declaration

    Swift

    public var float32: Float32?
  • Mechanica

    Returns a Float64 value by parsing self.

    Declaration

    Swift

    public var float64: Float64?
  • int

    Mechanica

    Returns a Int value by parsing self.

    Declaration

    Swift

    public var int: Int?
  • Mechanica

    Returns a Int8 value by parsing self.

    Declaration

    Swift

    public var int8: Int8?
  • Mechanica

    Returns a Int16 value by parsing self.

    Declaration

    Swift

    public var int16: Int16?
  • Mechanica

    Returns a Int32 value by parsing self.

    Declaration

    Swift

    public var int32: Int32?
  • Mechanica

    Returns a Int64 value by parsing self.

    Declaration

    Swift

    public var int64: Int64?
  • url

    Mechanica

    Returns an URL initialized with self.

    Declaration

    Swift

    public var url: URL?
  • Mechanica

    Returns a new string decoded from base64.

    Declaration

    Swift

    public var base64Decoded: String?
  • Mechanica

    Returns a new string encoded in base64.

    Declaration

    Swift

    public var base64Encoded: String?
  • Mechanica

    Returns true if the String contains one or more letters.

    Declaration

    Swift

    public var hasLetters: Bool
  • Mechanica

    Returns true if the String contains one or more numbers.

    Declaration

    Swift

    public var hasNumbers: Bool
  • Mechanica

    Returns true if the String contains only letters.

    Declaration

    Swift

    public var isAlphabetic: Bool
  • Mechanica

    Checks if the String contains only numbers.

    Declaration

    Swift

    public var isNumeric: Bool
  • Mechanica

    Returns true if the String contains at least one letter and one number.

    Declaration

    Swift

    public var isAlphaNumeric: Bool
  • Mechanica

    Returns true if all the characters are lowercased.

    Declaration

    Swift

    public var isLowercased: Bool
  • Mechanica

    Returns true, if all characters are uppercased. Otherwise, false.

    Declaration

    Swift

    public var isUppercased: Bool
  • Mechanica

    Checks if the String is blank (a string that is either empty or contains only space/newline characters).

    Declaration

    Swift

    public var isBlank: Bool
  • Mechanica

    Checks if all of the characters in a string are all the same.

    Declaration

    Swift

    public var isHomogeneous: Bool
  • Mechanica

    Returns true if the String is a valid email format.

    Declaration

    Swift

    public var isValidEmail: Bool