neco_gleam - v1.0.0

neco_gleam/scanner

Types

Scanner

opaque </> 
pub opaque type Scanner

Values

is_at_end

</> 
pub fn is_at_end(scanner: Scanner) -> Bool

length

</> 
pub fn length(scanner: Scanner) -> Int

new

</> 
pub fn new(source: BitArray) -> Scanner

peek

</> 
pub fn peek(scanner: Scanner) -> option.Option(Int)

Returns the current byte while preserving the scanner position, or None at the end of the input.

position

</> 
pub fn position(scanner: Scanner) -> Int

read

</> 
pub fn read(scanner: Scanner) -> Result(#(Int, Scanner), Nil)

Reads one byte and advances the returned scanner. End of input produces Error(Nil) while the input scanner remains available to the caller.

read_n

</> 
pub fn read_n(
  scanner: Scanner,
  take n: Int,
) -> Result(#(BitArray, Scanner), Nil)

Reads exactly n bytes and advances the returned scanner. A negative count or insufficient input produces Error(Nil). A zero count returns an empty bit array and the input scanner.

remaining

</> 
pub fn remaining(scanner: Scanner) -> Int

remaining_bytes

</> 
pub fn remaining_bytes(scanner: Scanner) -> BitArray

span

</> 
pub fn span(
  scanner: Scanner,
  from start: Int,
) -> Result(diagnostic.Span, diagnostic.Failure)

Creates [start, position(scanner)), returning InvalidSpan for a negative start or a start greater than the current position.

✨ Search Document