README
¶
AR archive format
Introduction
This library provides readers and writers with GNU ar archive files.
Documentation
You can use the standard Go documentation tool to read code documentation, for example:
go doc -all github.com/gearnode/ar
Contact
If you find a bug or have any question, feel free to open a Github issue or to contact me by email.
Please note that I do not currently review or accept any contribution.
Licence
Released under the ISC license.
Copyright (c) 2022 Bryan Frimin [email protected].
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Documentation
¶
Index ¶
Constants ¶
const ( HeaderByteSize = 60 MagicString = "!<arch>\n" )
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Header ¶
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader provides sequential access to the contents of a ar archive.
Reader.Next advances to the next file in the archive (including the first), and then Reader can be treated as an io.Reader to access the file's data.
func NewReader ¶
NewReader creates a new Reader reading from r.
An error is returned when the reader is not an ar file.
func (*Reader) Next ¶
Next advances to the next entry in the ar archive.
The Header.Size determines how many bytes can be read for the next file. Any remaining data in the current file is automatically discarded.
io.EOF is returned at the end of the input.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer provides sequential writing of a ar archive.
Write.WriteMagicBytes begins a new file, then WriteHeader begins a new file with the provided Header, and then Writer can be treated as an io.Writer to supply that file's data.
func (*Writer) Write ¶
Write writes to the current file in the ar archive.
Write returns the error ErrWriteTooLong if more than Header.Size bytes are written after WriteHeader.
func (*Writer) WriteHeader ¶
WriteHeader writes header and prepares to accept the file's contents.
The Header.Size determines how many bytes can be written for the next file. If the current file is not fully written, then this returns an error.
Source Files