Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

object

package

Go to main page

Versions in this module

v0

v0.16.2

Dec 23, 2024

v0.16.1

Dec 20, 2024

v0.16.0

Dec 20, 2024

Changes in this version

+ func PathRenameCombine(from, to string) string

type Commit

+ func (c *Commit) File(ctx context.Context, path string) (*File, error)

type File

+ Path string

type Tree

+ func (t *Tree) File(ctx context.Context, path string) (*File, error)

v0.15.1

Dec 16, 2024

v0.15.0

Dec 16, 2024

Changes in this version

+ var ErrMalformedChange = errors.New("malformed change: empty from and to")

type Change

+ func (c *Change) Name() string

type Changes

+ func (c Changes) Stats(ctx context.Context, opts *PatchOptions) (FileStats, error)

type File

+ func (f *File) IsFragments() bool

+ type PatchOptions struct

+ Algorithm diferenco.Algorithm

+ Match func(string) bool

+ Textconv bool

type Tree

+ func (t *Tree) StatsContext(ctx context.Context, to *Tree, m noder.Matcher, opts *PatchOptions) (FileStats, error)

v0.14.0

Nov 29, 2024

v0.13.0

Nov 22, 2024

Changes in this version

+ const BINARY

+ const BLOB_CACHE_SIZE_LIMIT

+ const BLOB_CURRENT_VERSION

+ const BROTLI

+ const BZ2

+ const BlobInlineMaxBytes

+ const DEFLATE

+ const DateFormat

+ const MAX_DIFF_SIZE

+ const STORE

+ const UTF8

+ const XZ

+ const ZSTD

+ const ZstandardMagic

+ var BLANK_BLOB_BYTES = [16]byte

+ var BLOB_MAGIC = [4]byte

+ var COMMIT_MAGIC = [4]byte

+ var DefaultDiffTreeOptions = &DiffTreeOptions

+ var ErrCanceled = errors.New("operation canceled")

+ var ErrMaxTreeDepth = errors.New("maximum tree depth exceeded")

+ var ErrMismatchedMagic = errors.New("mismatched magic")

+ var ErrMismatchedVersion = errors.New("mismatched version")

+ var ErrNotTextContent = errors.New("not a text content")

+ var ErrUnsupportedObject = errors.New("unsupported object type")

+ var FRAGMENTS_MAGIC = [4]byte

+ var TAG_MAGIC = [4]byte

+ var TREE_MAGIC = [4]byte

+ func Base64Decode(input string, oid plumbing.Hash, b Backend) (any, error)

+ func Base64DecodeAs[T Commit | Tree | Fragments | Tag](input string, oid plumbing.Hash, b Backend) (*T, error)

+ func Base64Encode(e Encoder) (string, error)

+ func Decode(r io.Reader, oid plumbing.Hash, b Backend) (any, error)

+ func GetUnifiedText(r io.Reader, size int64, codecvt bool) (string, string, error)

+ func Hash(e Encoder) plumbing.Hash

+ func HashFrom(r io.Reader) (plumbing.Hash, error)

+ func IsErrDirectoryNotFound(err error) bool

+ func IsErrEntryNotFound(err error) bool

+ func NewFilePatchWrapper(chunks []fdiff.Chunk, from, to fdiff.File, fragments bool) fdiff.FilePatch

+ func NewTextChunk(content string, op fdiff.Operation) fdiff.Chunk

+ func NewTextFilePatch(chunks []fdiff.Chunk, from, to ChangeEntry, fragments bool) fdiff.FilePatch

+ func NewTreeRootNode(t *Tree, m noder.Matcher, conflictDetection bool) noder.Noder

+ func NewUnifiedReader(r io.Reader) (io.Reader, error)

+ func StatsWriteTo(w io.Writer, fileStats []FileStat, color bool)

+ type Backend interface

+ Blob func(ctx context.Context, oid plumbing.Hash) (*Blob, error)

+ Commit func(ctx context.Context, oid plumbing.Hash) (*Commit, error)

+ Fragments func(ctx context.Context, oid plumbing.Hash) (*Fragments, error)

+ Tag func(ctx context.Context, oid plumbing.Hash) (*Tag, error)

+ Tree func(ctx context.Context, oid plumbing.Hash) (*Tree, error)

+ type Blob struct

+ Contents io.Reader

+ Size int64

+ func NewBlob(raw io.ReadCloser) (*Blob, error)

+ func (b *Blob) Close() error

+ type Change struct

+ From ChangeEntry

+ To ChangeEntry

+ func (c *Change) Action() (merkletrie.Action, error)

+ func (c *Change) Files() (from, to *File, err error)

+ func (c *Change) Patch(codecvt bool) (*Patch, error)

+ func (c *Change) PatchContext(ctx context.Context, codecvt bool) (*Patch, error)

+ func (c *Change) String() string

+ type ChangeEntry struct

+ Name string

+ Tree *Tree

+ TreeEntry TreeEntry

+ func (e *ChangeEntry) Equal(o *ChangeEntry) bool

+ func (e *ChangeEntry) IsFragments() bool

+ type Changes []*Change

+ func DetectRenames(ctx context.Context, changes Changes, opts *DiffTreeOptions) (Changes, error)

+ func DiffTree(a, b *Tree, m noder.Matcher) (Changes, error)

+ func DiffTreeContext(ctx context.Context, a, b *Tree, m noder.Matcher) (Changes, error)

+ func DiffTreeWithOptions(ctx context.Context, a, b *Tree, opts *DiffTreeOptions, m noder.Matcher) (Changes, error)

+ func (c Changes) Len() int

+ func (c Changes) Less(i, j int) bool

+ func (c Changes) Patch(codecvt bool) (*Patch, error)

+ func (c Changes) PatchContext(ctx context.Context, codecvt bool) (*Patch, error)

+ func (c Changes) String() string

+ func (c Changes) Swap(i, j int)

+ type Commit struct

+ Author Signature

+ Committer Signature

+ ExtraHeaders []*ExtraHeader

+ Hash plumbing.Hash

+ Message string

+ Parents []plumbing.Hash

+ Tree plumbing.Hash

+ func GetCommit(ctx context.Context, b Backend, oid plumbing.Hash) (*Commit, error)

+ func Independents(ctx context.Context, commits []*Commit) ([]*Commit, error)

+ func NewSnapshotCommit(cc *Commit, b Backend) *Commit

+ func (c *Commit) Decode(reader Reader) error

+ func (c *Commit) Encode(w io.Writer) error

+ func (c *Commit) IsAncestor(ctx context.Context, other *Commit) (bool, error)

+ func (c *Commit) Less(rhs *Commit) bool

+ func (c *Commit) MakeParents() CommitIter

+ func (c *Commit) MergeBase(ctx context.Context, other *Commit) ([]*Commit, error)

+ func (c *Commit) NumParents() int

+ func (c *Commit) PatchContext(ctx context.Context, to *Commit, m noder.Matcher, codecvt bool) (*Patch, error)

+ func (c *Commit) Pretty(w io.Writer) error

+ func (c *Commit) Root(ctx context.Context) (*Tree, error)

+ func (c *Commit) StatsContext(ctx context.Context, m noder.Matcher, codecvt bool) (FileStats, error)

+ func (c *Commit) String() string

+ func (c *Commit) Subject() string

+ type CommitFilter func(*Commit) bool

+ type CommitIter interface

+ Close func()

+ ForEach func(context.Context, func(*Commit) error) error

+ Next func(context.Context) (*Commit, error)

+ func NewCommitAllIter(ctx context.Context, rdb refs.Backend, odb Backend, ...) (CommitIter, error)

+ func NewCommitFileIterFromIter(fileName string, commitIter CommitIter, checkParent bool) CommitIter

+ func NewCommitIter(b Backend, hashes []plumbing.Hash) CommitIter

+ func NewCommitIterBSF(c *Commit, seenExternal map[plumbing.Hash]bool, ignore []plumbing.Hash) CommitIter

+ func NewCommitIterCTime(c *Commit, seenExternal map[plumbing.Hash]bool, ignore []plumbing.Hash) CommitIter

+ func NewCommitLimitIterFromIter(commitIter CommitIter, limitOptions LogLimitOptions) CommitIter

+ func NewCommitPathIterFromIter(pathFilter func(string) bool, commitIter CommitIter, checkParent bool) CommitIter

+ func NewCommitPostorderIter(c *Commit, ignore []plumbing.Hash) CommitIter

+ func NewCommitPreorderIter(c *Commit, seenExternal map[plumbing.Hash]bool, ignore []plumbing.Hash) CommitIter

+ func NewFilterCommitIter(from *Commit, isValid *CommitFilter, isLimit *CommitFilter) CommitIter

+ type CompressMethod uint16

+ type DiffTreeOptions struct

+ DetectRenames bool

+ OnlyExactRenames bool

+ RenameLimit uint

+ RenameScore uint

+ type Encoder interface

+ Encode func(io.Writer) error

+ type ErrDirectoryNotFound struct

+ func (e *ErrDirectoryNotFound) Error() string

+ type ErrEntryNotFound struct

+ func (e *ErrEntryNotFound) Error() string

+ type ExtraHeader struct

+ K string

+ V string

+ type File struct

+ Hash plumbing.Hash

+ Mode filemode.FileMode

+ Name string

+ Size int64

+ func (f *File) OriginReader(ctx context.Context) (io.ReadCloser, int64, error)

+ func (f *File) Reader(ctx context.Context) (io.ReadCloser, bool, error)

+ func (f *File) UnifiedText(ctx context.Context, codecvt bool) (content string, err error)

+ type FileIter struct

+ func NewFileIter(b Backend, t *Tree) *FileIter

+ func (iter *FileIter) Close()

+ func (iter *FileIter) ForEach(ctx context.Context, cb func(*File) error) error

+ func (iter *FileIter) Next(ctx context.Context) (*File, error)

+ type FileStat struct

+ Addition int

+ Deletion int

+ Name string

+ func (fs FileStat) String() string

+ type FileStats []FileStat

+ func (fileStats FileStats) String() string

+ type Fragment struct

+ Hash plumbing.Hash

+ Index uint32

+ Size uint64

+ type Fragments struct

+ Entries []*Fragment

+ Hash plumbing.Hash

+ Origin plumbing.Hash

+ Size uint64

+ func (f *Fragments) Decode(reader Reader) error

+ func (f *Fragments) Encode(w io.Writer) error

+ func (f *Fragments) Pretty(w io.Writer) error

+ type FragmentsOrder []*Fragment

+ func (s FragmentsOrder) Len() int

+ func (s FragmentsOrder) Less(i, j int) bool

+ func (s FragmentsOrder) Swap(i, j int)

+ type LogLimitOptions struct

+ Since *time.Time

+ Until *time.Time

+ type ObjectType int8

+ const AnyObject

+ const BlobObject

+ const CommitObject

+ const FragmentsObject

+ const InvalidObject

+ const OFSDeltaObject

+ const REFDeltaObject

+ const TagObject

+ const TreeObject

+ func HashObject(r io.Reader) (plumbing.Hash, ObjectType, error)

+ func ObjectTypeFromString(s string) ObjectType

+ func (t *ObjectType) UnmarshalJSON(b []byte) error

+ func (t ObjectType) MarshalJSON() ([]byte, error)

+ func (t ObjectType) String() string

+ type Patch struct

+ func NewPatch(message string, filePatches []fdiff.FilePatch) *Patch

+ func (p *Patch) Encode(w io.Writer) error

+ func (p *Patch) EncodeEx(w io.Writer, useColor bool) error

+ func (p *Patch) FilePatches() []fdiff.FilePatch

+ func (p *Patch) Message() string

+ func (p *Patch) Stats() FileStats

+ func (p *Patch) String() string

+ type Printer interface

+ Pretty func(io.Writer) error

+ type Reader interface

+ Hash func() plumbing.Hash

+ Type func() ObjectType

+ type Signature struct

+ Email string

+ Name string

+ When time.Time

+ func (s *Signature) Decode(b []byte)

+ func (s *Signature) String() string

+ type SubtreeOrder []*TreeEntry

+ func (s SubtreeOrder) Len() int

+ func (s SubtreeOrder) Less(i, j int) bool

+ func (s SubtreeOrder) Name(i int) string

+ func (s SubtreeOrder) Swap(i, j int)

+ type Tag struct

+ Content string

+ Hash plumbing.Hash

+ Name string

+ Object plumbing.Hash

+ ObjectType ObjectType

+ Tagger Signature

+ func (t *Tag) Decode(reader Reader) error

+ func (t *Tag) Encode(w io.Writer) error

+ func (t *Tag) Equal(other *Tag) bool

+ func (t *Tag) Extract() (message string, signature string)

+ func (t *Tag) Message() string

+ func (t *Tag) Pretty(w io.Writer) error

+ type Tree struct

+ Entries []*TreeEntry

+ Hash plumbing.Hash

+ func NewSnapshotTree(t *Tree, b Backend) *Tree

+ func NewTree(entries []*TreeEntry) *Tree

+ func (t *Tree) Append(others *TreeEntry)

+ func (t *Tree) Decode(reader Reader) error

+ func (t *Tree) Diff(to *Tree, m noder.Matcher) (Changes, error)

+ func (t *Tree) DiffContext(ctx context.Context, to *Tree, m noder.Matcher) (Changes, error)

+ func (t *Tree) Encode(w io.Writer) error

+ func (t *Tree) Entry(name string) (*TreeEntry, error)

+ func (t *Tree) Equal(other *Tree) bool

+ func (t *Tree) Files() *FileIter

+ func (t *Tree) FindEntry(ctx context.Context, relativePath string) (*TreeEntry, error)

+ func (t *Tree) Merge(others ...*TreeEntry) *Tree

+ func (t *Tree) Patch(to *Tree, m noder.Matcher, codecvt bool) (*Patch, error)

+ func (t *Tree) PatchContext(ctx context.Context, to *Tree, m noder.Matcher, codecvt bool) (*Patch, error)

+ func (t *Tree) Pretty(w io.Writer) error

+ func (t *Tree) SizePadding() int

+ func (t *Tree) SpacePadding() int

+ func (t *Tree) Tree(ctx context.Context, path string) (*Tree, error)

+ type TreeEntry struct

+ Hash plumbing.Hash

+ Mode filemode.FileMode

+ Name string

+ Payload []byte

+ Size int64

+ func (e *TreeEntry) Chmod(other *TreeEntry) bool

+ func (e *TreeEntry) Clone() *TreeEntry

+ func (e *TreeEntry) Equal(other *TreeEntry) bool

+ func (e *TreeEntry) IsFragments() bool

+ func (e *TreeEntry) IsLink() bool

+ func (e *TreeEntry) Modified(other *TreeEntry) bool

+ func (e *TreeEntry) OriginMode() filemode.FileMode

+ func (e *TreeEntry) Renamed(other *TreeEntry) bool

+ func (e *TreeEntry) Type() ObjectType

+ type TreeNoder struct

+ func (t *TreeNoder) Children(ctx context.Context) ([]noder.Noder, error)

+ func (t *TreeNoder) Hash() []byte

+ func (t *TreeNoder) HashRaw() plumbing.Hash

+ func (t *TreeNoder) IsDir() bool

+ func (t *TreeNoder) IsFragments() bool

+ func (t *TreeNoder) Mode() filemode.FileMode

+ func (t *TreeNoder) Name() string

+ func (t *TreeNoder) NumChildren(ctx context.Context) (int, error)

+ func (t *TreeNoder) Size() int64

+ func (t *TreeNoder) Skip() bool

+ func (t *TreeNoder) String() string

+ func (t *TreeNoder) TrueMode() filemode.FileMode

+ type TreeWalker struct

+ func NewTreeWalker(t *Tree, recursive bool, seen map[plumbing.Hash]bool) *TreeWalker

+ func (w *TreeWalker) Close()

+ func (w *TreeWalker) Next(ctx context.Context) (name string, entry *TreeEntry, err error)

+ func (w *TreeWalker) Tree() *Tree