go-eol/README.md

53 lines
1.2 KiB
Markdown
Raw Normal View History

2023-11-27 14:46:40 +00:00
# go-eol
Package **eol** implements tools for working with end-of-line, for the Go programming language.
The end-of-line sequences it supports is:
2023-11-27 19:33:48 +00:00
* `"\n" // line-feed (LF)`
2024-03-26 06:05:26 +00:00
* `"\v" // vertical-tab (VT)`
2024-02-18 18:08:54 +00:00
* `"\n\r" // line-feed (LF), carriage-return (CR)`
2023-11-27 19:33:48 +00:00
* `"\r" // carriage-return (CR)`
* `"\r\n" // carriage-return (CR), line-feed (LF)`
* `"\u0085" // next-line (NEL)`
* `"\u2028" // line-separator (LS)`
2023-11-27 14:46:40 +00:00
## Documention
Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-eol
[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-eol?status.svg)](https://godoc.org/sourcecode.social/reiver/go-eol)
## Example
Here is an example:
```golang
import "sourcecode.social/reiver/go-eol"
// ...
eodofline, size, err := eol.ReadEOL(runereader)
if nil != err {
return err
}
```
## Import
To import package **eol** use `import` code like the follownig:
```
import "sourcecode.social/reiver/go-eol"
```
## Installation
To install package **eol** do the following:
```
GOPROXY=direct go get https://sourcecode.social/reiver/go-eol
```
## Author
Package **eol** was written by [Charles Iliya Krempeaux](http://changelog.ca)