Some documentation changes

This commit is contained in:
Caleb Gardner
2020-11-29 03:07:34 -06:00
parent faf9153323
commit c5f1962e72
2 changed files with 2 additions and 5 deletions
+2 -1
View File
@@ -149,7 +149,8 @@ func (f *File) IsSymlink() bool {
return f.filType == inode.BasicSymlinkType || f.filType == inode.ExtSymlinkType return f.filType == inode.BasicSymlinkType || f.filType == inode.ExtSymlinkType
} }
//SymlinkPath returns the path the symlink is pointing to. If the file ISN'T a symlink, will return an empty string //SymlinkPath returns the path the symlink is pointing to. If the file ISN'T a symlink, will return an empty string.
//If a path begins with "/" then the symlink is pointing to an absolute path (starting from root, and not a file inside the archive)
func (f *File) SymlinkPath() string { func (f *File) SymlinkPath() string {
switch f.filType { switch f.filType {
case inode.BasicSymlinkType: case inode.BasicSymlinkType:
-4
View File
@@ -21,13 +21,9 @@ var (
errIncompatibleCompression = errors.New("Compression type unsupported") errIncompatibleCompression = errors.New("Compression type unsupported")
//ErrCompressorOptions is returned if compressor options is present. It's not currently supported. //ErrCompressorOptions is returned if compressor options is present. It's not currently supported.
errCompressorOptions = errors.New("Compressor options is not currently supported") errCompressorOptions = errors.New("Compressor options is not currently supported")
//ErrFragmentTableIssues is returned if there's trouble reading the fragment table when creating a reader.
//When this is returned, the reader is still returned.
errFragmentTableIssues = errors.New("Trouble while reading the fragment table")
) )
//Reader processes and reads a squashfs archive. //Reader processes and reads a squashfs archive.
//TODO: Give a way to actually read files :P
type Reader struct { type Reader struct {
r io.ReaderAt r io.ReaderAt
super superblock super superblock