Skip to content

clarify documentation and fix doc markup #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
majewsky wants to merge 1 commit into
base: master
Choose a base branch
from
Open

clarify documentation and fix doc markup #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions reader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*
/*
Copyright (c) 2013 Blake Smith <blakesmith0@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
Expand Down Expand Up @@ -29,47 +29,47 @@ import (
"time"
)

// Provides read access to an ar archive.
// Call next to skip files
//
// Reader provides read access to an ar archive.
// Call next to skip files.
//
// Example:
// reader := NewReader(f)
// var buf bytes.Buffer
// for {
// _, err := reader.Next()
// if err == io.EOF {
// break
// }
// if err != nil {
// t.Errorf(err.Error())
// }
// io.Copy(&buf, reader)
// }

//
// reader := NewReader(f)
// var buf bytes.Buffer
// for {
// _, err := reader.Next()
// if err == io.EOF {
// break
// }
// if err != nil {
// t.Errorf(err.Error())
// }
// io.Copy(&buf, reader)
// }
type Reader struct {
r io.Reader
nb int64
r io.Reader
nb int64
pad int64
}

// Copies read data to r. Strips the global ar header.
// NewReader creates a new reader reading from r. It strips the global ar header.
func NewReader(r io.Reader) *Reader {
io.CopyN(ioutil.Discard, r, 8) // Discard global header

return &Reader{r: r}
}

func (rd *Reader) string(b []byte) string {
i := len(b)-1
i := len(b) - 1
for i > 0 && b[i] == 32 {
i--
}

return string(b[0:i+1])
return string(b[0 : i+1])
}

func (rd *Reader) numeric(b []byte) int64 {
i := len(b)-1
i := len(b) - 1
for i > 0 && b[i] == 32 {
i--
}
Expand All @@ -80,7 +80,7 @@ func (rd *Reader) numeric(b []byte) int64 {
}

func (rd *Reader) octal(b []byte) int64 {
i := len(b)-1
i := len(b) - 1
for i > 0 && b[i] == 32 {
i--
}
Expand Down Expand Up @@ -128,19 +128,19 @@ func (rd *Reader) readHeader() (*Header, error) {
return header, nil
}

// Call Next() to skip to the next file in the archive file.
// Returns a Header which contains the metadata about the
// file in the archive.
// Next skips to the next file in the archive file.
// Returns a Header which contains the metadata about the
// file in the archive. io.EOF is returned at the end of the input.
func (rd *Reader) Next() (*Header, error) {
err := rd.skipUnread()
if err != nil {
return nil, err
}

return rd.readHeader()
}

// Read data from the current entry in the archive.
// Read reads data from the current entry in the archive.
func (rd *Reader) Read(b []byte) (n int, err error) {
if rd.nb == 0 {
return 0, io.EOF
Expand Down