14.2.51  String

The standard library String api defines access to immutable vectors of characters.

The String api is implemented by the string package.

The String api source code is in src/lib/std/src/string.api.

See also: Rw_Vector.

See also: Substring.

See also: Char.

The above information is manually maintained and may contain errors.

api {
    eqtype Char ;
    eqtype String ;
    max_size : Int;
    length : String -> Int;
    get : (String , Int) -> Char;
    _[] : (String , Int) -> Char;
    extract : (String , Int , Null_Or(Int )) -> String;
    substring : (String , Int , Int) -> String;
    + : (String , String) -> String;
    cat : List(String ) -> String;
    join : String -> List(String ) -> String;
    join' : String
            -> String -> String -> List(String ) -> String;
    from_char : Char -> String;
    implode : List(Char ) -> String;
    explode : String -> List(Char );
    chomp : String -> String;
    map : (Char -> Char) -> String -> String;
    translate : (Char -> String) -> String -> String;
    tokens : (Char -> Bool) -> String -> List(String );
    fields : (Char -> Bool) -> String -> List(String );
    is_prefix : String -> String -> Bool;
    is_substring : String -> String -> Bool;
    is_suffix : String -> String -> Bool;
    compare : (String , String) -> Order;
    collate : ((Char , Char) -> Order)
              -> (String , String) -> Order;
    to_lower : String -> String;
    to_upper : String -> String;
    to_mixed : String -> String;
    has_alpha : String -> Bool;
    has_lower : String -> Bool;
    has_upper : String -> Bool;
    is_alpha : String -> Bool;
    is_upper : String -> Bool;
    is_lower : String -> Bool;
    is_mixed : String -> Bool;
    < : (String , String) -> Bool;
    <= : (String , String) -> Bool;
    > : (String , String) -> Bool;
    >= : (String , String) -> Bool;
    from_string : string::String -> Null_Or(String );
    to_string : String -> string::String;
    from_cstring : string::String -> Null_Or(String );
    to_cstring : String -> string::String;
};