Crate radicle_surf

radicle-surf is a library to help users explore a Git repository with ease. It supports browsing a repository via the concept of files and directories, or via blobs and trees in a git fashion. With the additional support of diff::Diff and History, this library can be used to build an intuitive UI for any Git repository.

The main entry point of the library API is Repository.

Let’s start surfing!

Serialization with feature serde

Many types in this crate support serialization using Serde through the serde feature flag for this crate.

Re-exports

• pub use radicle_git_ext::ref_format;

Modules

• blob
  Represents git object type ‘blob’, i.e. actual file contents. See git doc for more details.
• diff
  Types that represent diff(s) in a Git repo.
• fs
  Definition for a file system consisting of Directory and File.
• tree
  Represents git object type ‘tree’, i.e. like directory entries in Unix. See git doc for more details.

Structs

• Author
  Represents the authorship of actions in a git repo.
• Commit
  Commit is the metadata of a Git commit.
• Glob
  A collection of globs for a git reference type.
• History
  An iterator that produces the history of commits for a given head.
• Local
  A Local represents a local branch, i.e. it is a reference under refs/heads.
• Namespace
  A Namespace value allows us to switch the git namespace of a repo.
• Remote
  A Remote represents a remote branch, i.e. it is a reference under refs/remotes.
• Repository
  Represents the state associated with a Git repository.
• Signature
  The signature of a commit
• Stats
  Stats for a repository
• Time
  Time used in the authorship of an action in a git repo.

Enums

• Branch
  A Branch represents any git branch. It can be Local or Remote.
• Error
  The crate level error type that wraps up module level error types.
• Tag
  The metadata of a Git tag.

Traits

• Revision
  Supports various ways to specify a revision used in Git.
• ToCommit
  A common trait for anything that can convert to a Commit.

Type Aliases

• Oid
  Represents an object id in Git. Re-exported from radicle-git-ext.