String handling functions.
class
StringException:
object.Exception;
Exception thrown on errors in std.string functions.
Examples:import std.exception : assertThrown;auto bad =" a\n\tb\n c";assertThrown!StringException(bad.outdent);
pure nothrow @nogc @system inout
(Char)[]
fromStringz(Char)(return scope inout(Char)*
cString)
if (isSomeChar!Char);
pure nothrow @nogc @safe inout
(Char)[]
fromStringz(Char)(return scope inout(Char)[]
cString)
if (isSomeChar!Char);
Parameters:inout(Char)*cString | A null-terminated c-style string. |
Returns:A D-style array of
char,
wchar or
dchar referencing the same string. The returned array will retain the same type qualifiers as the input.
Important Note: The returned array is a slice of the original buffer. The original data is not changed and not copied.
Examples:writeln(fromStringz("foo\0"c.ptr));// "foo"cwriteln(fromStringz("foo\0"w.ptr));// "foo"wwriteln(fromStringz("foo\0"d.ptr));// "foo"dwriteln(fromStringz("福\0"c.ptr));// "福"cwriteln(fromStringz("福\0"w.ptr));// "福"wwriteln(fromStringz("福\0"d.ptr));// "福"d Examples:struct C{char[32] name;}writeln(C("foo\0"c).name.fromStringz());// "foo"cstruct W{wchar[32] name;}writeln(W("foo\0"w).name.fromStringz());// "foo"wstruct D{dchar[32] name;}writeln(D("foo\0"d).name.fromStringz());// "foo"d pure nothrow @trusted immutable(char)*
toStringz(scope const(char)[]
s);
Parameters:const(char)[]s | A D-style string. |
Returns:A C-style null-terminated string equivalent to
s.
s must not contain embedded
'\0''s as any C function will treat the first
'\0' that it sees as the end of the string. If
s.empty is
true, then a string containing only
'\0' is returned.
Important Note: When passing a
char* to a C function, and the C function keeps it around for any reason, make sure that you keep a reference to it in your D code. Otherwise, it may become invalid during a garbage collection cycle and cause a nasty bug when the C code tries to use it.
Examples:import core.stdc.string : strlen;import std.conv : to;auto p =toStringz("foo");writeln(strlen(p));// 3const(char)[] foo ="abbzxyzzy";p =toStringz(foo[3 .. 5]);writeln(strlen(p));// 2string test ="";p =toStringz(test);writeln(*p);// 0test ="\0";p =toStringz(test);writeln(*p);// 0test ="foo\0";p =toStringz(test);assert(p[0] == 'f' && p[1] == 'o' && p[2] == 'o' && p[3] == 0);const string test2 ="";p =toStringz(test2);writeln(*p);// 0assert(toStringz([])istoStringz("")); alias
CaseSensitive = std.typecons.Flag!"caseSensitive".Flag;
Flag indicating whether a search is case-sensitive.
ptrdiff_t
indexOf(Range)(Range
s, dchar
c, CaseSensitive
cs = Yes.caseSensitive)
if (isInputRange!Range && isSomeChar!(ElementType!Range) && !isSomeString!Range);
ptrdiff_t
indexOf(C)(scope const(C)[]
s, dchar
c, CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!C);
ptrdiff_t
indexOf(Range)(Range
s, dchar
c, size_t
startIdx, CaseSensitive
cs = Yes.caseSensitive)
if (isInputRange!Range && isSomeChar!(ElementType!Range) && !isSomeString!Range);
ptrdiff_t
indexOf(C)(scope const(C)[]
s, dchar
c, size_t
startIdx, CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!C);
Searches for a character in a string or range.
Parameters:Ranges | string or InputRange of characters to search forc in |
dcharc | character to search for ins |
size_tstartIdx | index to a well-formed code point ins to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive). |
Returns:Ifc is found ins, then the index of its first occurrence is returned. Ifc is not found orstartIdx is greater than or equal tos.length, then -1 is returned. If the parameters are not valid UTF, the result will still be either -1 or in the range [startIdx ..s.length], but will not be reliable otherwise.
Throws:If the sequence starting at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:import std.typecons : No;strings ="Hello World";writeln(indexOf(s, 'W'));// 6writeln(indexOf(s, 'Z'));// -1writeln(indexOf(s, 'w', No.caseSensitive));// 6
Examples:import std.typecons : No;strings ="Hello World";writeln(indexOf(s, 'W', 4));// 6writeln(indexOf(s, 'Z', 100));// -1writeln(indexOf(s, 'w', 3, No.caseSensitive));// 6
ptrdiff_t
indexOf(Range, Char)(Range
s, const(Char)[]
sub)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && isSomeChar!Char);
ptrdiff_t
indexOf(Range, Char)(Range
s, const(Char)[]
sub, in CaseSensitive
cs)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && isSomeChar!Char);
@safe ptrdiff_t
indexOf(Char1, Char2)(const(Char1)[]
s, const(Char2)[]
sub, in size_t
startIdx)
if (isSomeChar!Char1 && isSomeChar!Char2);
@safe ptrdiff_t
indexOf(Char1, Char2)(const(Char1)[]
s, const(Char2)[]
sub, in size_t
startIdx, in CaseSensitive
cs)
if (isSomeChar!Char1 && isSomeChar!Char2);
Searches for a substring in a string or range.
Parameters:Ranges | string or ForwardRange of characters to search forsub in |
const(Char)[]sub | substring to search for ins |
size_tstartIdx | index to a well-formed code point ins to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the first occurrence ofsub ins. Ifsub is not found orstartIdx is greater than or equal tos.length, then -1 is returned. If the arguments are not valid UTF, the result will still be either -1 or in the range [startIdx ..s.length], but will not be reliable otherwise.
Throws:If the sequence starting at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:import std.typecons : No;strings ="Hello World";writeln(indexOf(s,"Wo", 4));// 6writeln(indexOf(s,"Zo", 100));// -1writeln(indexOf(s,"wo", 3, No.caseSensitive));// 6
Examples:import std.typecons : No;strings ="Hello World";writeln(indexOf(s,"Wo"));// 6writeln(indexOf(s,"Zo"));// -1writeln(indexOf(s,"wO", No.caseSensitive));// 6
pure @safe ptrdiff_t
lastIndexOf(Char)(const(Char)[]
s, in dchar
c, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char);
pure @safe ptrdiff_t
lastIndexOf(Char)(const(Char)[]
s, in dchar
c, in size_t
startIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char);
Searches for the last occurrence of a character in a string.
Parameters:const(Char)[]s | string to search forc in |
dcharc | character to search for ins |
size_tstartIdx | index of a well-formed code point ins to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:Ifc is found ins, then the index of its last occurrence is returned. Ifc is not found orstartIdx is greater than or equal tos.length, then -1 is returned. If the parameters are not valid UTF, the result will still be either -1 or in the range [startIdx ..s.length], but will not be reliable otherwise.
Throws:If the sequence ending at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:import std.typecons : No;strings ="Hello World";writeln(lastIndexOf(s, 'l'));// 9writeln(lastIndexOf(s, 'Z'));// -1writeln(lastIndexOf(s, 'L', No.caseSensitive));// 9
Examples:import std.typecons : No;strings ="Hello World";writeln(lastIndexOf(s, 'l', 4));// 3writeln(lastIndexOf(s, 'Z', 1337));// -1writeln(lastIndexOf(s, 'L', 7, No.caseSensitive));// 3
pure @safe ptrdiff_t
lastIndexOf(Char1, Char2)(const(Char1)[]
s, const(Char2)[]
sub, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char1 && isSomeChar!Char2);
pure @safe ptrdiff_t
lastIndexOf(Char1, Char2)(const(Char1)[]
s, const(Char2)[]
sub, in size_t
startIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char1 && isSomeChar!Char2);
Searches for the last occurrence of a substring in a string.
Parameters:const(Char1)[]s | string to search forsub in |
const(Char2)[]sub | substring to search for ins |
size_tstartIdx | index to a well-formed code point ins to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the last occurrence ofsub ins. Ifsub is not found orstartIdx is greater than or equal tos.length, then -1 is returned. If the parameters are not valid UTF, the result will still be either -1 or in the range [startIdx ..s.length], but will not be reliable otherwise.
Throws:If the sequence starting at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:import std.typecons : No;strings ="Hello World";writeln(lastIndexOf(s,"ll"));// 2writeln(lastIndexOf(s,"Zo"));// -1writeln(lastIndexOf(s,"lL", No.caseSensitive));// 2
Examples:import std.typecons : No;strings ="Hello World";writeln(lastIndexOf(s,"ll", 4));// 2writeln(lastIndexOf(s,"Zo", 128));// -1writeln(lastIndexOf(s,"lL", 3, No.caseSensitive));// -1
pure @safe ptrdiff_t
indexOfAny(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
pure @safe ptrdiff_t
indexOfAny(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in size_t
startIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
Searches the stringhaystack for one of the characters inneedles starting at indexstartIdx. IfstartIdx is not given, it defaults to 0.
Parameters:const(Char)[]haystack | string to search for needles in |
const(Char2)[]needles | characters to search for inhaystack |
size_tstartIdx | index of a well-formed code point inhaystack to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the first occurrence of any of the elements ofneedles inhaystack. If no element ofneedles is found orstartIdx is greater than or equal tohaystack.length, then -1 is returned. If the parameters are not valid UTF, the result will still be either -1 or in the range [startIdx ..haystack.length], but will not be reliable otherwise.
Throws:If the sequence starting at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:import std.conv : to;ptrdiff_t i ="helloWorld".indexOfAny("Wr");writeln(i);// 5i ="öällo world".indexOfAny("lo ");writeln(i);// 4 Examples:import std.conv : to;ptrdiff_t i ="helloWorld".indexOfAny("Wr", 4);writeln(i);// 5i ="Foo öällo world".indexOfAny("lh", 3);writeln(i);// 8 pure @safe ptrdiff_t
lastIndexOfAny(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
pure @safe ptrdiff_t
lastIndexOfAny(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in size_t
stopIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
Searcheshaystack for the last occurrence of any of the characters inneedles.
Parameters:const(Char)[]haystack | string to search needles in |
const(Char2)[]needles | characters to search for inhaystack |
size_tstopIdx | index inhaystack to stop searching at (exclusive); defaults tohaystack.length |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the last occurrence of any of the characters ofneedles inhaystack. If no character ofneedles is found orstopIdx is 0, then -1 is returned. If the parameters are not valid UTF, the result will still be in the range [-1 ..stopIdx], but will not be reliable otherwise.
Examples:ptrdiff_t i ="helloWorld".lastIndexOfAny("Wlo");writeln(i);// 8i ="Foo öäöllo world".lastIndexOfAny("öF");writeln(i);// 8 Examples:import std.conv : to;ptrdiff_t i ="helloWorld".lastIndexOfAny("Wlo", 4);writeln(i);// 3i ="Foo öäöllo world".lastIndexOfAny("öF", 3);writeln(i);// 0 pure @safe ptrdiff_t
indexOfNeither(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
pure @safe ptrdiff_t
indexOfNeither(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in size_t
startIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
Searcheshaystack for a character not inneedles.
Parameters:const(Char)[]haystack | string to search for needles in |
const(Char2)[]needles | characters to search for inhaystack |
size_tstartIdx | index of a well-formed code point inhaystack to start searching from; defaults to 0 |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the first character inhaystack that is not an element ofneedles. If all characters ofhaystack are elements ofneedles orstartIdx is greater than or equal tohaystack.length, then -1 is returned. If the parameters are not valid UTF, the result will still be either -1 or in the range [startIdx ..haystack.length], but will not be reliable otherwise.
Throws:If the sequence starting at
startIdx does not represent a well-formed code point, then a
std.utf.UTFException may be thrown.
Examples:writeln(indexOfNeither("abba","a", 2));// 2writeln(indexOfNeither("def","de", 1));// 2writeln(indexOfNeither("dfefffg","dfe", 4));// 6 Examples:writeln(indexOfNeither("def","a"));// 0writeln(indexOfNeither("def","de"));// 2writeln(indexOfNeither("dfefffg","dfe"));// 6 pure @safe ptrdiff_t
lastIndexOfNeither(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
pure @safe ptrdiff_t
lastIndexOfNeither(Char, Char2)(const(Char)[]
haystack, const(Char2)[]
needles, in size_t
stopIdx, in CaseSensitive
cs = Yes.caseSensitive)
if (isSomeChar!Char && isSomeChar!Char2);
Searches for the last character inhaystack that is not inneedles.
Parameters:const(Char)[]haystack | string to search for needles in |
const(Char2)[]needles | characters to search for inhaystack |
size_tstopIdx | index inhaystack to stop searching at (exclusive); defaults tohaystack.length |
CaseSensitivecs | specifies whether comparisons are case-sensitive (Yes.caseSensitive) or not (No.caseSensitive) |
Returns:The index of the last character inhaystack that is not an element ofneedles. If all characters ofhaystack are inneedles orstopIdx is 0, then -1 is returned. If the parameters are not valid UTF, the result will still be in the range [-1 ..stopIdx], but will not be reliable otherwise.
Examples:writeln(lastIndexOfNeither("abba","a"));// 2writeln(lastIndexOfNeither("def","f"));// 1 Examples:writeln(lastIndexOfNeither("def","rsa", 3));// -1writeln(lastIndexOfNeither("abba","a", 2));// 1 pure nothrow @nogc @safe auto
representation(Char)(Char[]
s)
if (isSomeChar!Char);
Returns the representation of a string, which has the same type as the string except the character type is replaced byubyte,ushort, oruint depending on the character width.
Parameters:Char[]s | The string to return the representation of. |
Returns:The representation of the passed string.
Examples:strings ="hello";staticassert(is(typeof(representation(s)) ==immutable(ubyte)[]));assert(representation(s)iscast(immutable(ubyte)[])s);writeln(representation(s));// [0x68, 0x65, 0x6c, 0x6c, 0x6f]
pure @trusted S
capitalize(S)(S
input)
if (isSomeString!S);
Capitalize the first character ofs and convert the rest ofs to lowercase.
Parameters:Sinput | The string to capitalize. |
Returns:The capitalized string.
Examples:writeln(capitalize("hello"));// "Hello"writeln(capitalize("World"));// "World" alias
KeepTerminator = std.typecons.Flag!"keepTerminator".Flag;
pure @safe C[][]
splitLines(C)(C[]
s, KeepTerminator
keepTerm = No.keepTerminator)
if (isSomeChar!C);
Split
s into an array of lines according to the unicode standard using
'\r',
'\n',
"\r\n",
std.uni.lineSep,
std.uni.paraSep,
U+0085 (NEL),
'\v' and
'\f' as delimiters. If
keepTerm is set to
KeepTerminator.yes, then the delimiter is included in the strings returned.
Does not throw on invalid UTF; such is simply passed unchanged to the output.
Allocates memory; use
lineSplitter for an alternative that does not.
Adheres to
Unicode 7.0.
Parameters:C[]s | a string ofchars,wchars, ordchars, or any custom type that casts to astring type |
KeepTerminatorkeepTerm | whether delimiter is included or not in the results |
Returns:array of strings, each element is a line that is a slice ofs
Examples:strings ="Hello\nmy\rname\nis";writeln(splitLines(s));// ["Hello", "my", "name", "is"]
auto
lineSplitter(KeepTerminator keepTerm = No.keepTerminator, Range)(Range
r)
if (hasSlicing!Range && hasLength!Range && isSomeChar!(ElementType!Range) && !isSomeString!Range);
auto
lineSplitter(KeepTerminator keepTerm = No.keepTerminator, C)(C[]
r)
if (isSomeChar!C);
Split an array or slicable range of characters into a range of lines using
'\r',
'\n',
'\v',
'\f',
"\r\n",
std.uni.lineSep,
std.uni.paraSep and
'\u0085' (NEL) as delimiters. If
keepTerm is set to
Yes.keepTerminator, then the delimiter is included in the slices returned.
Does not throw on invalid UTF; such is simply passed unchanged to the output.
Adheres to
Unicode 7.0.
Does not allocate memory.
Parameters:Ranger | array ofchars,wchars, ordchars or a slicable range |
| keepTerm | whether delimiter is included or not in the results |
Returns:range of slices of the input ranger
Examples:import std.array : array;string s ="Hello\nmy\rname\nis";/* notice the call to 'array' to turn the lazy range created bylineSplitter comparable to the string[] created by splitLines.*/writeln(lineSplitter(s).array);// splitLines(s)
Examples:auto s ="\rpeter\n\rpaul\r\njerry\u2028ice\u2029cream\n\nsunday\nmon\u2030day\n";auto lines = s.lineSplitter();staticimmutable witness = ["","peter","","paul","jerry","ice","cream","","sunday","mon\u2030day"];uint i;foreach (line; lines){ writeln(line);// witness[i++]}writeln(i);// witness.length auto
stripLeft(Range)(Range
input)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && !isInfinite!Range && !isConvertibleToString!Range);
auto
stripLeft(Range, Char)(Range
input, const(Char)[]
chars)
if ((isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) || isConvertibleToString!Range) && isSomeChar!Char);
Strips leading whitespace (as defined by
std.uni.isWhite) or as specified in the second argument.
Parameters:Rangeinput | string orforward range of characters |
const(Char)[]chars | string of characters to be stripped |
Returns:input stripped of leading whitespace or characters specified in the second argument.
Postconditionsinput and the returned value will share the same tail (seestd.array.sameTail).
Examples:import std.uni : lineSep, paraSep;assert(stripLeft(" hello world ") =="hello world ");assert(stripLeft("\n\t\v\rhello world\n\t\v\r") =="hello world\n\t\v\r");assert(stripLeft(" \u2028hello world") =="hello world");assert(stripLeft("hello world") =="hello world");assert(stripLeft([lineSep] ~"hello world" ~ lineSep) =="hello world" ~ [lineSep]);assert(stripLeft([paraSep] ~"hello world" ~ paraSep) =="hello world" ~ [paraSep]);import std.array : array;import std.utf : byChar;assert(stripLeft(" hello world "w.byChar).array =="hello world ");assert(stripLeft(" \u2022hello world ".byChar).array =="\u2022hello world "); Examples:assert(stripLeft(" hello world "," ") =="hello world ");assert(stripLeft("xxxxxhello world ","x") =="hello world ");assert(stripLeft("xxxyy hello world ","xy ") =="hello world "); Examples:import std.array : array;import std.utf : byChar, byWchar, byDchar;assert(stripLeft(" xxxyy hello world "w.byChar,"xy ").array =="hello world ");assert(stripLeft("\u2028\u2020hello world\u2028"w.byWchar,"\u2028").array =="\u2020hello world\u2028");assert(stripLeft("\U00010001hello world"w.byWchar," ").array =="\U00010001hello world"w);assert(stripLeft("\U00010001 xyhello world"d.byDchar,"\U00010001 xy").array =="hello world"d);writeln(stripLeft("\u2020hello"w,"\u2020"w));// "hello"wwriteln(stripLeft("\U00010001hello"d,"\U00010001"d));// "hello"dwriteln(stripLeft(" hello ",""));// " hello " auto
stripRight(Range)(Range
str)
if (isSomeString!Range || isRandomAccessRange!Range && hasLength!Range && hasSlicing!Range && !isConvertibleToString!Range && isSomeChar!(ElementEncodingType!Range));
auto
stripRight(Range, Char)(Range
str, const(Char)[]
chars)
if ((isBidirectionalRange!Range && isSomeChar!(ElementEncodingType!Range) || isConvertibleToString!Range) && isSomeChar!Char);
Strips trailing whitespace (as defined by
std.uni.isWhite) or as specified in the second argument.
Parameters:Rangestr | string or random access range of characters |
const(Char)[]chars | string of characters to be stripped |
Returns:slice ofstr stripped of trailing whitespace or characters specified in the second argument.
Examples:import std.uni : lineSep, paraSep;assert(stripRight(" hello world ") ==" hello world");assert(stripRight("\n\t\v\rhello world\n\t\v\r") =="\n\t\v\rhello world");assert(stripRight("hello world") =="hello world");assert(stripRight([lineSep] ~"hello world" ~ lineSep) == [lineSep] ~"hello world");assert(stripRight([paraSep] ~"hello world" ~ paraSep) == [paraSep] ~"hello world"); Examples:assert(stripRight(" hello world ","x") ==" hello world ");assert(stripRight(" hello world "," ") ==" hello world");assert(stripRight(" hello worldxy ","xy ") ==" hello world"); auto
strip(Range)(Range
str)
if (isSomeString!Range || isRandomAccessRange!Range && hasLength!Range && hasSlicing!Range && !isConvertibleToString!Range && isSomeChar!(ElementEncodingType!Range));
auto
strip(Range, Char)(Range
str, const(Char)[]
chars)
if ((isBidirectionalRange!Range && isSomeChar!(ElementEncodingType!Range) || isConvertibleToString!Range) && isSomeChar!Char);
auto
strip(Range, Char)(Range
str, const(Char)[]
leftChars, const(Char)[]
rightChars)
if ((isBidirectionalRange!Range && isSomeChar!(ElementEncodingType!Range) || isConvertibleToString!Range) && isSomeChar!Char);
Strips both leading and trailing whitespace (as defined by
std.uni.isWhite) or as specified in the second argument.
Parameters:Rangestr | string or random access range of characters |
const(Char)[]chars | string of characters to be stripped |
const(Char)[]leftChars | string of leading characters to be stripped |
const(Char)[]rightChars | string of trailing characters to be stripped |
Returns:slice ofstr stripped of leading and trailing whitespace or characters as specified in the second argument.
Examples:import std.uni : lineSep, paraSep;assert(strip(" hello world ") =="hello world");assert(strip("\n\t\v\rhello world\n\t\v\r") =="hello world");assert(strip("hello world") =="hello world");assert(strip([lineSep] ~"hello world" ~ [lineSep]) =="hello world");assert(strip([paraSep] ~"hello world" ~ [paraSep]) =="hello world"); Examples:assert(strip(" hello world ","x") ==" hello world ");assert(strip(" hello world "," ") =="hello world");assert(strip(" xyxyhello worldxyxy ","xy ") =="hello world");writeln(strip("\u2020hello\u2020"w,"\u2020"w));// "hello"wwriteln(strip("\U00010001hello\U00010001"d,"\U00010001"d));// "hello"dwriteln(strip(" hello ",""));// " hello " Examples:writeln(strip("xxhelloyy","x","y"));// "hello"assert(strip(" xyxyhello worldxyxyzz ","xy ","xyz ") =="hello world");writeln(strip("\u2020hello\u2028"w,"\u2020"w,"\u2028"w));// "hello"wassert(strip("\U00010001hello\U00010002"d,"\U00010001"d,"\U00010002"d) =="hello"d);writeln(strip(" hello ","",""));// " hello " Range
chomp(Range)(Range
str)
if ((isRandomAccessRange!Range && isSomeChar!(ElementEncodingType!Range) || isNarrowString!Range) && !isConvertibleToString!Range);
Range
chomp(Range, C2)(Range
str, const(C2)[]
delimiter)
if ((isBidirectionalRange!Range && isSomeChar!(ElementEncodingType!Range) || isNarrowString!Range) && !isConvertibleToString!Range && isSomeChar!C2);
Ifstr ends withdelimiter, thenstr is returned withoutdelimiter on its end. If itstr doesnot end withdelimiter, then it is returned unchanged.
If no
delimiter is given, then one trailing
'\r',
'\n',
"\r\n",
'\f',
'\v',
std.uni.lineSep,
std.uni.paraSep, or
std.uni.nelSep is removed from the end of
str. If
str does not end with any of those characters, then it is returned unchanged.
Parameters:Rangestr | string or indexable range of characters |
const(C2)[]delimiter | string of characters to be sliced off end of str[] |
Examples:import std.uni : lineSep, paraSep, nelSep;import std.utf : decode;writeln(chomp(" hello world \n\r"));// " hello world \n"writeln(chomp(" hello world \r\n"));// " hello world "writeln(chomp(" hello world \f"));// " hello world "writeln(chomp(" hello world \v"));// " hello world "writeln(chomp(" hello world \n\n"));// " hello world \n"writeln(chomp(" hello world \n\n "));// " hello world \n\n "writeln(chomp(" hello world \n\n" ~ [lineSep]));// " hello world \n\n"writeln(chomp(" hello world \n\n" ~ [paraSep]));// " hello world \n\n"writeln(chomp(" hello world \n\n" ~ [nelSep]));// " hello world \n\n"writeln(chomp(" hello world "));// " hello world "writeln(chomp(" hello world"));// " hello world"writeln(chomp(""));// ""writeln(chomp(" hello world","orld"));// " hello w"writeln(chomp(" hello world"," he"));// " hello world"writeln(chomp("","hello"));// ""// Don't decode pointlesslywriteln(chomp("hello\xFE","\r"));// "hello\xFE" Range
chompPrefix(Range, C2)(Range
str, const(C2)[]
delimiter)
if ((isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) || isNarrowString!Range) && !isConvertibleToString!Range && isSomeChar!C2);
Ifstr starts withdelimiter, then the part ofstr followingdelimiter is returned. Ifstr doesnot start with
delimiter, then it is returned unchanged.
Parameters:Rangestr | string orforward range of characters |
const(C2)[]delimiter | string of characters to be sliced off front of str[] |
Examples:writeln(chompPrefix("hello world","he"));// "llo world"writeln(chompPrefix("hello world","hello w"));// "orld"writeln(chompPrefix("hello world"," world"));// "hello world"writeln(chompPrefix("","hello"));// "" Range
chop(Range)(Range
str)
if ((isBidirectionalRange!Range && isSomeChar!(ElementEncodingType!Range) || isNarrowString!Range) && !isConvertibleToString!Range);
Returnsstr without its last character, if there is one. Ifstr ends with"\r\n", then both are removed. Ifstr is empty, then it is returned unchanged.
Parameters:Rangestr | string (must be valid UTF) |
Examples:writeln(chop("hello world"));// "hello worl"writeln(chop("hello world\n"));// "hello world"writeln(chop("hello world\r"));// "hello world"writeln(chop("hello world\n\r"));// "hello world\n"writeln(chop("hello world\r\n"));// "hello world"writeln(chop("Walter Bright"));// "Walter Brigh"writeln(chop(""));// "" S
leftJustify(S)(S
s, size_t
width, dchar
fillChar = ' ')
if (isSomeString!S);
Left justifys in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thats doesn't fill.
Parameters:Ss | string |
size_twidth | minimum field width |
dcharfillChar | used to pad end up towidth characters |
Returns:GC allocated string
Examples:writeln(leftJustify("hello", 7, 'X'));// "helloXX"writeln(leftJustify("hello", 2, 'X'));// "hello"writeln(leftJustify("hello", 9, 'X'));// "helloXXXX" auto
leftJustifier(Range)(Range
r, size_t
width, dchar
fillChar = ' ')
if (isInputRange!Range && isSomeChar!(ElementEncodingType!Range) && !isConvertibleToString!Range);
Left justifys in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thats doesn't fill.
Parameters:Ranger | string or range of characters |
size_twidth | minimum field width |
dcharfillChar | used to pad end up towidth characters |
Returns:a lazy range of the left justified result
Examples:import std.algorithm.comparison : equal;import std.utf : byChar;assert(leftJustifier("hello", 2).equal("hello".byChar));assert(leftJustifier("hello", 7).equal("hello ".byChar));assert(leftJustifier("hello", 7, 'x').equal("helloxx".byChar)); S
rightJustify(S)(S
s, size_t
width, dchar
fillChar = ' ')
if (isSomeString!S);
Right justifys in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thats doesn't fill.
Parameters:Ss | string |
size_twidth | minimum field width |
dcharfillChar | used to pad end up towidth characters |
Returns:GC allocated string
Examples:writeln(rightJustify("hello", 7, 'X'));// "XXhello"writeln(rightJustify("hello", 2, 'X'));// "hello"writeln(rightJustify("hello", 9, 'X'));// "XXXXhello" auto
rightJustifier(Range)(Range
r, size_t
width, dchar
fillChar = ' ')
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && !isConvertibleToString!Range);
Right justifys in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thats doesn't fill.
Parameters:Ranger | string orforward range of characters |
size_twidth | minimum field width |
dcharfillChar | used to pad end up towidth characters |
Returns:a lazy range of the right justified result
Examples:import std.algorithm.comparison : equal;import std.utf : byChar;assert(rightJustifier("hello", 2).equal("hello".byChar));assert(rightJustifier("hello", 7).equal(" hello".byChar));assert(rightJustifier("hello", 7, 'x').equal("xxhello".byChar)); S
center(S)(S
s, size_t
width, dchar
fillChar = ' ')
if (isSomeString!S);
Centers in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thats doesn't fill.
Parameters:Ss | The string to center |
size_twidth | Width of the field to centers in |
dcharfillChar | The character to use for filling excess space in the field |
Returns:The resulting center-justified string. The returned string is GC-allocated. To avoid GC allocation, use
centerJustifier instead.
Examples:writeln(center("hello", 7, 'X'));// "XhelloX"writeln(center("hello", 2, 'X'));// "hello"writeln(center("hello", 9, 'X'));// "XXhelloXX" auto
centerJustifier(Range)(Range
r, size_t
width, dchar
fillChar = ' ')
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && !isConvertibleToString!Range);
Center justifyr in a fieldwidth characters wide.fillChar is the character that will be used to fill up the space in the field thatr doesn't fill.
Parameters:Ranger | string orforward range of characters |
size_twidth | minimum field width |
dcharfillChar | used to pad end up towidth characters |
Returns:a lazy range of the center justified result
Examples:import std.algorithm.comparison : equal;import std.utf : byChar;assert(centerJustifier("hello", 2).equal("hello".byChar));assert(centerJustifier("hello", 8).equal(" hello ".byChar));assert(centerJustifier("hello", 7, 'x').equal("xhellox".byChar)); pure auto
detab(Range)(auto ref Range
s, size_t
tabSize = 8)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) || __traits(compiles, StringTypeOf!Range));
Replace each tab character ins with the number of spaces necessary to align the following character at the next tab stop.
Parameters:Ranges | string |
size_ttabSize | distance between tab stops |
Returns:GC allocated string with tabs replaced with spaces
Examples:writeln(detab(" \n\tx", 9));// " \n x" auto
detabber(Range)(Range
r, size_t
tabSize = 8)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range) && !isConvertibleToString!Range);
auto
detabber(Range)(auto ref Range
r, size_t
tabSize = 8)
if (isConvertibleToString!Range);
Replace each tab character inr with the number of spaces necessary to align the following character at the next tab stop.
Parameters:Ranger | string orforward range |
size_ttabSize | distance between tab stops |
Returns:lazy forward range with tabs replaced with spaces
Examples:import std.array : array;writeln(detabber(" \n\tx", 9).array);// " \n x" Examples:import std.array : array;import std.utf : byChar, byWchar;writeln(detabber(" \u2029\t".byChar, 9).array);// " \u2029 "autor ="hel\tx".byWchar.detabber();writeln(r.front);// 'h'auto s =r.save;r.popFront();r.popFront();writeln(r.front);// 'l'writeln(s.front);// 'h' auto
entab(Range)(Range
s, size_t
tabSize = 8)
if (isForwardRange!Range && isSomeChar!(ElementEncodingType!Range));
Replaces spaces ins with the optimal number of tabs. All spaces and tabs at the end of a line are removed.
Parameters:Ranges | String to convert. |
size_ttabSize | Tab columns aretabSize spaces apart. |
Returns:GC allocated string with spaces replaced with tabs; use
entabber to not allocate.
Examples:writeln(entab(" x \n"));// "\tx\n" auto
entabber(Range)(Range
r, size_t
tabSize = 8)
if (isForwardRange!Range && !isConvertibleToString!Range);
Replaces spaces in ranger with the optimal number of tabs. All spaces and tabs at the end of a line are removed.
Parameters:Ranger | string orforward range |
size_ttabSize | distance between tab stops |
Returns:lazy forward range with spaces replaced with tabs
Examples:import std.array : array;writeln(entabber(" x \n").array);// "\tx\n" pure @safe C1[]
translate(C1, C2 = immutable(char))(C1[]
str, in dchar[dchar]
transTable, const(C2)[]
toRemove = null)
if (isSomeChar!C1 && isSomeChar!C2);
pure @safe C1[]
translate(C1, S, C2 = immutable(char))(C1[]
str, in S[dchar]
transTable, const(C2)[]
toRemove = null)
if (isSomeChar!C1 && isSomeString!S && isSomeChar!C2);
Replaces the characters instr which are keys intransTable with their corresponding values intransTable.transTable is an AA where its keys aredchar and its values are eitherdchar or some type of string. Also, iftoRemove is given, the characters in it are removed fromstr prior to translation.str itself is unaltered. A copy with the changes is returned.
Parameters:C1[]str | The original string. |
dchar[dchar]transTable | The AA indicating which characters to replace and what to replace them with. |
const(C2)[]toRemove | The characters to remove from the string. |
Examples:dchar[dchar] transTable1 = ['e' : '5', 'o' : '7', '5': 'q'];writeln(translate("hello world", transTable1));// "h5ll7 w7rld"writeln(translate("hello world", transTable1,"low"));// "h5 rd"string[dchar] transTable2 = ['e' :"5", 'o' :"orange"];writeln(translate("hello world", transTable2));// "h5llorange worangerld" void
translate(C1, C2 = immutable(char), Buffer)(const(C1)[]
str, in dchar[dchar]
transTable, const(C2)[]
toRemove, Buffer
buffer)
if (isSomeChar!C1 && isSomeChar!C2 && isOutputRange!(Buffer, C1));
void
translate(C1, S, C2 = immutable(char), Buffer)(C1[]
str, in S[dchar]
transTable, const(C2)[]
toRemove, Buffer
buffer)
if (isSomeChar!C1 && isSomeString!S && isSomeChar!C2 && isOutputRange!(Buffer, S));
This is an overload oftranslate which takes an existing buffer to write the contents to.
Parameters:const(C1)[]str | The original string. |
dchar[dchar]transTable | The AA indicating which characters to replace and what to replace them with. |
const(C2)[]toRemove | The characters to remove from the string. |
Bufferbuffer | An output range to write the contents to. |
Examples:import std.array : appender;dchar[dchar] transTable1 = ['e' : '5', 'o' : '7', '5': 'q'];autobuffer = appender!(dchar[])();translate("hello world", transTable1,null,buffer);writeln(buffer.data);// "h5ll7 w7rld"buffer.clear();translate("hello world", transTable1,"low",buffer);writeln(buffer.data);// "h5 rd"buffer.clear();string[dchar] transTable2 = ['e' :"5", 'o' :"orange"];translate("hello world", transTable2,null,buffer);writeln(buffer.data);// "h5llorange worangerld" pure nothrow @trusted C[]
translate(C = immutable(char))(scope const(char)[]
str, scope const(char)[]
transTable, scope const(char)[]
toRemove = null)
if (is(immutable(C) == immutable(char)));
This is an
ASCII-only overload of
translate. It will
not work with Unicode. It exists as an optimization for the cases where Unicode processing is not necessary.
Unlike the other overloads of
translate, this one does not take an AA. Rather, it takes a
string generated by
makeTransTable.
The array generated by
makeTransTable is
256 elements long such that the index is equal to the ASCII character being replaced and the value is equal to the character that it's being replaced with. Note that translate does not decode any of the characters, so you can actually pass it Extended ASCII characters if you want to (ASCII only actually uses
128 characters), but be warned that Extended ASCII characters are not valid Unicode and therefore will result in a
UTFException being thrown from most other Phobos functions.
Also, because no decoding occurs, it is possible to use this overload to translate ASCII characters within a proper UTF-8 string without altering the other, non-ASCII characters. It's replacing any code unit greater than
127 with another code unit or replacing any code unit with another code unit greater than
127 which will cause UTF validation issues.
Parameters:const(char)[]str | The original string. |
const(char)[]transTable | The string indicating which characters to replace and what to replace them with. It is generated bymakeTransTable. |
const(char)[]toRemove | The characters to remove from the string. |
Examples:auto transTable1 = makeTrans("eo5","57q");writeln(translate("hello world", transTable1));// "h5ll7 w7rld"writeln(translate("hello world", transTable1,"low"));// "h5 rd" pure nothrow @trusted string
makeTrans(scope const(char)[]
from, scope const(char)[]
to);
Do same thing as
makeTransTable but allocate the translation table on the GC heap.
Examples:auto transTable1 =makeTrans("eo5","57q");writeln(translate("hello world", transTable1));// "h5ll7 w7rld"writeln(translate("hello world", transTable1,"low"));// "h5 rd" pure nothrow @nogc @safe char[256]
makeTransTable(scope const(char)[]
from, scope const(char)[]
to);
Construct 256 character translation table, where characters in from[] are replaced by corresponding characters in to[].
Parameters:const(char)[]from | array of chars, less than or equal to 256 in length |
const(char)[]to | corresponding array of chars to translate to |
Returns:translation array
Examples:writeln(translate("hello world",makeTransTable("hl","q5")));// "qe55o wor5d"writeln(translate("hello world",makeTransTable("12345","67890")));// "hello world" pure @trusted void
translate(C = immutable(char), Buffer)(scope const(char)[]
str, scope const(char)[]
transTable, scope const(char)[]
toRemove, Buffer
buffer)
if (is(immutable(C) == immutable(char)) && isOutputRange!(Buffer, char));
This is anASCII-only overload oftranslate which takes an existing buffer to write the contents to.
Parameters:const(char)[]str | The original string. |
const(char)[]transTable | The string indicating which characters to replace and what to replace them with. It is generated bymakeTransTable. |
const(char)[]toRemove | The characters to remove from the string. |
Bufferbuffer | An output range to write the contents to. |
Examples:import std.array : appender;autobuffer = appender!(char[])();auto transTable1 = makeTransTable("eo5","57q");translate("hello world", transTable1,null,buffer);writeln(buffer.data);// "h5ll7 w7rld"buffer.clear();translate("hello world", transTable1,"low",buffer);writeln(buffer.data);// "h5 rd" pure @safe S
succ(S)(S
s)
if (isSomeString!S);
Return string that is the 'successor' to s[]. If the rightmost character is a-zA-Z0-9, it is incremented within its case or digits. If it generates a carry, the process is repeated with the one to its immediate left.
Examples:writeln(succ("1"));// "2"writeln(succ("9"));// "10"writeln(succ("999"));// "1000"writeln(succ("zz99"));// "aaa00" C1[]
tr(C1, C2, C3, C4 = immutable(char))(C1[]
str, const(C2)[]
from, const(C3)[]
to, const(C4)[]
modifiers = null);
Replaces the characters instr which are infrom with the the corresponding characters into and returns the resulting string.
tr is based on
Posix's tr, though it doesn't do everything that the Posix utility does.
Parameters:C1[]str | The original string. |
const(C2)[]from | The characters to replace. |
const(C3)[]to | The characters to replace with. |
const(C4)[]modifiers | String containing modifiers. |
Modifiers
| Modifier | Description |
| 'c' | Complement the list of characters infrom |
| 'd' | Removes matching characters with no corresponding replacement into |
| 's' | Removes adjacent duplicates in the replaced characters |
If the modifier
'd' is present, then the number of characters in
to may be only
0 or
1.
If the modifier
'd' is
not present, and
to is empty, then
to is taken to be the same as
from.
If the modifier
'd' is
not present, and
to is shorter than
from, then
to is extended by replicating the last character in
to.
Both
from and
to may contain ranges using the
'-' character (e.g.
"a-d" is synonymous with
"abcd".) Neither accept a leading
'^' as meaning the complement of the string (use the
'c' modifier for that).
Examples:writeln(tr("abcdef","cd","CD"));// "abCDef"writeln(tr("1st March, 2018","March","MAR","s"));// "1st MAR, 2018"writeln(tr("abcdef","ef","","d"));// "abcd"writeln(tr("14-Jul-87","a-zA-Z"," ","cs"));// " Jul " bool
isNumeric(S)(S
s, bool
bAllowSep = false)
if (isSomeString!S || isRandomAccessRange!S && hasSlicing!S && isSomeChar!(ElementType!S) && !isInfinite!S);
Takes a strings and determines if it represents a number. This function also takes an optional parameter,bAllowSep, which will accept the separator characters',' and'__' within the string. But these characters should be stripped from the string before using any of the conversion functions liketo!int(),to!float(), and etc else an error will occur.
Also please note, that no spaces are allowed within the string anywhere whether it's a leading, trailing, or embedded space(s), thus they too must be stripped from the string before using this function, or any of the conversion functions.
Parameters:Ss | the string or random access range to check |
boolbAllowSep | accept separator characters or not |
Examples:Integer Whole Number: (byte, ubyte, short, ushort, int, uint, long, and ulong) ['+'|'-']digit(s)[U|L|UL]
assert(isNumeric("123"));assert(isNumeric("123UL"));assert(isNumeric("123L"));assert(isNumeric("+123U"));assert(isNumeric("-123L")); Examples:Floating-Point Number: (float, double, real, ifloat, idouble, and ireal) ['+'|'-']digit(s)[.][digit(s)][[e-|e+]digit(s)][i|f|L|Li|fi]] or [nan|nani|inf|-inf]
assert(isNumeric("+123"));assert(isNumeric("-123.01"));assert(isNumeric("123.3e-10f"));assert(isNumeric("123.3e-10fi"));assert(isNumeric("123.3e-10L"));assert(isNumeric("nan"));assert(isNumeric("nani"));assert(isNumeric("-inf")); Examples:Floating-Point Number: (cfloat, cdouble, and creal) ['+'|'-']digit(s)[.][digit(s)][[e-|e+]digit(s)][+] [digit(s)[.][digit(s)][[e-|e+]digit(s)][i|f|L|Li|fi]] or [nan|nani|nan+nani|inf|-inf]
assert(isNumeric("-123e-1+456.9e-10Li"));assert(isNumeric("+123e+10+456i"));assert(isNumeric("123+456")); Examples:isNumeric works with CTFE
enum a =isNumeric("123.00E-5+1234.45E-12Li");enum b =isNumeric("12345xxxx890");staticassert( a);staticassert(!b); char[4]
soundexer(Range)(Range
str)
if (isInputRange!Range && isSomeChar!(ElementEncodingType!Range) && !isConvertibleToString!Range);
char[4]
soundexer(Range)(auto ref Range
str)
if (isConvertibleToString!Range);
Soundex algorithm.
The Soundex algorithm converts a word into 4 characters based on how the word sounds phonetically. The idea is that two spellings that sound alike will have the same Soundex value, which means that Soundex can be used for fuzzy matching of names.
Parameters:Rangestr | String or InputRange to convert to Soundex representation. |
Returns:The four character array with the Soundex result in it. The array has zero's in it if there is no Soundex representation for the string.
NoteOnly works well with English names.
Examples:writeln(soundexer("Gauss"));// "G200"writeln(soundexer("Ghosh"));// "G200"writeln(soundexer("Robert"));// "R163"writeln(soundexer("Rupert"));// "R163"writeln(soundexer("0123^&^^**&^"));// ['\0', '\0', '\0', '\0'] pure nothrow @safe char[]
soundex(scope const(char)[]
str, return scope char[]
buffer = null);
Like
soundexer, but with different parameters and return value.
Parameters:const(char)[]str | String to convert to Soundex representation. |
char[]buffer | Optional 4 char array to put the resulting Soundex characters into. If null, the return value buffer will be allocated on the heap. |
Returns:The four character array with the Soundex result in it. Returns null if there is no Soundex representation for the string.
Examples:writeln(soundex("Gauss"));// "G200"writeln(soundex("Ghosh"));// "G200"writeln(soundex("Robert"));// "R163"writeln(soundex("Rupert"));// "R163"writeln(soundex("0123^&^^**&^"));// null pure @safe string[string]
abbrev(string[]
values);
Construct an associative array consisting of all abbreviations that uniquely map to the strings in values.
This is useful in cases where the user is expected to type in one of a known set of strings, and the program will helpfully auto-complete the string once sufficient characters have been entered that uniquely identify it.
Examples:import std.string;static string[] list = ["food","foxy" ];auto abbrevs =abbrev(list);assert(abbrevs == ["fox":"foxy","food":"food","foxy":"foxy","foo":"food"]);
size_t
column(Range)(Range
str, in size_t
tabsize = 8)
if ((isInputRange!Range && isSomeChar!(ElementEncodingType!Range) || isNarrowString!Range) && !isConvertibleToString!Range);
Compute column number at the end of the printed form of the string, assuming the string starts in the leftmost column, which is numbered starting from 0.
Tab characters are expanded into enough spaces to bring the column number to the next multiple of tabsize. If there are multiple lines in the string, the column number of the last line is returned.
Parameters:Rangestr | string or InputRange to be analyzed |
size_ttabsize | number of columns a tab character represents |
Examples:import std.utf : byChar, byWchar, byDchar;writeln(column("1234 "));// 5writeln(column("1234 "w));// 5writeln(column("1234 "d));// 5writeln(column("1234 ".byChar()));// 5writeln(column("1234 "w.byWchar()));// 5writeln(column("1234 "d.byDchar()));// 5// Tab stops are set at 8 spaces by default; tab characters insert enough// spaces to bring the column position to the next multiple of 8.writeln(column("\t"));// 8writeln(column("1\t"));// 8writeln(column("\t1"));// 9writeln(column("123\t"));// 8// Other tab widths are possible by specifying it explicitly:writeln(column("\t", 4));// 4writeln(column("1\t", 4));// 4writeln(column("\t1", 4));// 5writeln(column("123\t", 4));// 4// New lines reset the column number.writeln(column("abc\n"));// 0writeln(column("abc\n1"));// 1writeln(column("abcdefg\r1234"));// 4writeln(column("abc\u20281"));// 1writeln(column("abc\u20291"));// 1writeln(column("abc\u00851"));// 1writeln(column("abc\u00861"));// 5 S
wrap(S)(S
s, in size_t
columns = 80, S
firstindent = null, S
indent = null, in size_t
tabsize = 8)
if (isSomeString!S);
Wrap text into a paragraph.
The input text string s is formed into a paragraph by breaking it up into a sequence of lines, delineated by \n, such that the number of columns is not exceeded on each line. The last line is terminated with a \n.
Parameters:Ss | text string to be wrapped |
size_tcolumns | maximum number of columns in the paragraph |
Sfirstindent | string used to indent first line of the paragraph |
Sindent | string to use to indent following lines of the paragraph |
size_ttabsize | column spacing of tabs in firstindent[] and indent[] |
Returns:resulting paragraph as an allocated string
Bugs:Columns are counted as the number of code points in the string. This may not correspond with the actual number of columns displayed if the string contains combining characters, modifiers, zero-width characters, or double-width characters.
Examples:writeln(wrap("a short string", 7));// "a short\nstring\n"// wrap will not break inside of a word, but at the next spacewriteln(wrap("a short string", 4));// "a\nshort\nstring\n"writeln(wrap("a short string", 7,"\t"));// "\ta\nshort\nstring\n"writeln(wrap("a short string", 7,"\t"," "));// "\ta\n short\n string\n" pure @safe S
outdent(S)(S
str)
if (isSomeString!S);
Removes one level of indentation from a multi-line string.
This uniformly outdents the text as much as possible. Whitespace-only lines are always converted to blank lines.
Does not allocate memory if it does not throw.
Throws:StringException if indentation is done with different sequences of whitespace characters.
Examples:enum pretty =q{ import std.stdio; void main() { writeln("Hello"); }}.outdent();enum ugly =q{import std.stdio;void main() {writeln("Hello");}};writeln(pretty);// ugly pure @safe S[]
outdent(S)(return scope S[]
lines)
if (isSomeString!S);
Removes one level of indentation from an array of single-line strings.
This uniformly outdents the text as much as possible. Whitespace-only lines are always converted to blank lines.
Parameters:S[]lines | array of single-line strings |
Returns:lines[] is rewritten in place with outdented lines
Throws:StringException if indentation is done with different sequences of whitespace characters.
Examples:auto str1 = [" void main()\n"," {\n"," test();\n"," }\n"];auto str1Expected = ["void main()\n","{\n"," test();\n","}\n"];writeln(str1.outdent);// str1Expectedauto str2 = ["void main()\n"," {\n"," test();\n"," }\n"];writeln(str2.outdent);// str2 auto
assumeUTF(T)(T[]
arr)
if (staticIndexOf!(immutable(T), immutable(ubyte), immutable(ushort), immutable(uint)) != -1);
Assume the given array of integersarr is a well-formed UTF string andreturn it typed as a UTF string.
ubyte becomes
char,
ushort becomes
wchar and
uintbecomes
dchar. Type qualifiers are preserved.
When compiled with debug mode, this function performs an extra check to makesure the return value is a valid Unicode string.
Parameters:T[]arr | array of bytes, ubytes, shorts, ushorts, ints, or uints |
Returns:arr retyped as an array of chars, wchars, or dchars
Throws:In debug modeAssertError, when the result is not a well-formed UTF string.
Examples:string a ="Hölo World";immutable(ubyte)[] b = a.representation;string c = b.assumeUTF;writeln(c);// "Hölo World"