Crate libgitdit

The git-dit library

This library provides low-level functionality for accessing, creating and manipulating “git-dit” issues and messages. It is implemented on top of the git2 crate. This librarie’s documentation primarily provides information about its API and abstract processing of issues and messages.

Issues

Issues are stored in git repositories. The issues availible in a repository may be accessed through the RepositoryExt extension trait implementation for git2::Repository.

An issue is primarily a tree of messages, consisting of at least an initial message. An issue also has a “head reference”. The head reference lets the maintainer indicate an “upstream status” of the issue, e.g. by pointing to a message which introduces a textual solution or a state.

Messages

Like emails, messages are immutable once released to the public. Each message has an author and a creation date. Additionally, a message may contain arbitrary metadata in the form of git trailers.

Re-exports

• pub use error::Error;
• pub use issue::Issue;
• pub use message::Message;
• pub use remote::RemoteExt;
• pub use repository::RepositoryExt;

Modules

• error
• gc
  Garbage collecting utilities
• issue
  Issues
• iter
  Utility iterators
• message
  Message handling utilities
• remote
  Module providing extension trait for remotes
• repository
  Repository related utilities
• trailer
  Trailer related functionality