go-eol/readcr.go

25 lines
696 B
Go
Raw Normal View History

2023-11-27 19:32:08 +00:00
package eol
import (
"io"
2023-11-28 16:07:35 +00:00
"sourcecode.social/reiver/go-opt"
2024-02-18 17:09:29 +00:00
"sourcecode.social/reiver/go-eol/cr"
2023-11-27 19:32:08 +00:00
)
2023-11-28 16:29:07 +00:00
// ReadCR tries to read the "\r" (i.e., carriage-return) end-of-line sequence.
//
// If successful, it returns the number-of-bytes read (to read in end-of-line sequence "\r").
//
// If the character read is not a '\r', then ReadCR will try to unread the character.
//
// Example usage:
//
// size, err := eol.ReadCR(runescanner)
2023-11-27 19:32:08 +00:00
func ReadCR(runescanner io.RuneScanner) (size int, err error) {
2023-11-28 16:07:35 +00:00
const characterNumber uint64 = 1
2024-02-18 17:27:47 +00:00
var circumstance internalCircumstance = specifyCircumstance(opt.Something(cr.String), characterNumber)
2024-02-18 17:09:29 +00:00
return readthisrune(circumstance, runescanner, cr.Rune)
2023-11-27 19:32:08 +00:00
}