README
¶
go-yenc
go-yenc is a yenc encoder and decoder library for Go.
Usage
Encoding
yenc.Encode(out io.Writer, in io.Reader, lineLength int, filename string) error
Encode uses a basic io.Reader to access the binary data to be encoded and
an io.Writer that receives the encoded inforation.
The lineLength parameter determines the length of each encoded line. Per
version 1.3 of the specification, the
line length may be one character longer than this as an escape code cannot
appear in isolation.
fileName contains the name of the original file being encoded. As the
function utilizes low-level readers and writers, the name must be provided
separately. The file name is encoded into the =ybegin header and is emitted
by the Decode function
Decoding
yenc.Decode(out io.Writer, in io.Reader) error
The current implementation of Decode currently handles only single-part
files. There are several improvements to the code underway.
Similar to Encode, Decode accepts a basic io.Reader which supplies the
encoded data and a basic io.Writer which receives the decoded infomration.
Contributing
- Fork it
- Create a feature branch (
git checkout -b new-feature) - Commit changes (
git commit -am "Added new feature xyz") - Push the branch (
git push origin new-feature) - Create a new pull request.
Maintainers
License
Copyright 2020 MediaExchange.io
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Documentation
¶
Index ¶
- Constants
- func Decode(out io.Writer, in io.Reader) (err error)
- func Encode(out io.Writer, in io.Reader, lineLength int, filename string) error
- func IsCritical(b byte) bool
- func ParseMarkerLine(line string, prefix string) map[string]string
- func ReadLine(in *bufio.Reader) (buf bytes.Buffer, err error)
Constants ¶
Variables ¶
This section is empty.
Functions ¶
func Encode ¶
Encode writes ASCII characters that were encoded from binary input using the yEnc algorithm, made popular by binary Usenet groups. Any line length may be used, but the most commonly used value is 128 characters.
func IsCritical ¶
IsCritical returns `true` if the byte is one of the "critical" values.
func ParseMarkerLine ¶
ParseMarkerLine parses a line that uses the format, `prefix key=value key=value...`
Types ¶
This section is empty.
Source Files
Directories