string function

  1. @useResult
Parser<String> string(
  1. String string, {
  2. String? message,
  3. bool ignoreCase = false,
})

Returns a parser that accepts the string.

  • message defines a custom error message.
  • If ignoreCase is true, the string is matched in a case-insensitive manner.

For example, string('foo') succeeds and consumes the input string 'foo'. Fails for any other input.

Implementation

@useResult
Parser<String> string(
  String string, {
  String? message,
  bool ignoreCase = false,
}) => ignoreCase
    ? StringIgnoreCaseParser(
        string,
        message ?? '"$string" (case-insensitive) expected',
      )
    : StringParser(string, message ?? '"$string" expected');