README
T
CommitInfo
T
ObjectStore
- ::add_objectsObjectStore::add_objects
- ::containsObjectStore::contains
- ::from_packObjectStore::from_pack
- ::getObjectStore::get
- ::newObjectStore::new
V
apply_shallow_updates
V
checkout_commit
V
checkout_commit_to_fs
V
checkout_commit_to_fs_async
V
is_gitlink_mode
V
is_tree_mode
V
join_path
V
materialize_clone_to_fs
V
materialize_clone_to_fs_async
V
parent_dir
V
parse_commit
V
parse_tree
V
read_shallow_boundaries
V
verify_tree_entry_name
V
write_git_metadata
V
write_git_metadata_async

bit_repo

Repository handle and materialization

git

repo

moon add mizchi/bit_repo@0.46.4

Download zip

Author

mizchi

Version

0.46.4

License

Apache-2.0

Repository

github.com/mizchi/bit-vcs

Last updated

4 days ago

Downloads

567

Dependencies

README

#
CommitInfo

source

pub struct CommitInfo {
  tree : @mizchi/bit_object.ObjectId
ObjectId
  parents : Array[@mizchi/bit_object.ObjectId
ObjectId]
}

#
ObjectStore

source

pub struct ObjectStore {
  objects : Map[String, @mizchi/bit_object.PackObject
PackObject]
}

#
ObjectStore::add_objects

source

fn ObjectStore::add_objects(self : ObjectStore, objects : Array[@mizchi/bit_object.PackObject
PackObject]) -> Unit

#
ObjectStore::contains

source

fn ObjectStore::contains(self : ObjectStore, id : @mizchi/bit_object.ObjectId
ObjectId) -> Bool

#
ObjectStore::from_pack

source

fn ObjectStore::from_pack(objects : Array[@mizchi/bit_object.PackObject
PackObject]) -> ObjectStore

#
ObjectStore::get

source

fn ObjectStore::get(self : ObjectStore, id : @mizchi/bit_object.ObjectId
ObjectId) -> @mizchi/bit_object.PackObject
PackObject?

#
ObjectStore::new

source

fn ObjectStore::new() -> ObjectStore

#
apply_shallow_updates

source

fn apply_shallow_updates(fs : &@mizchi/bit_types.FileSystem
FileSystem, rfs : &@mizchi/bit_types.RepoFileSystem
RepoFileSystem, git_dir : String, shallow : Array[@mizchi/bit_object.ObjectId
ObjectId], unshallow : Array[@mizchi/bit_object.ObjectId
ObjectId]) -> Unit raise @mizchi/bit_object.GitError
GitError

#
checkout_commit

source

fn checkout_commit(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId) -> Map[String, Bytes] raise @mizchi/bit_object.GitError
GitError

#
checkout_commit_to_fs

source

fn checkout_commit_to_fs(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, fs : &@mizchi/bit_types.FileSystem
FileSystem, root : String, rfs : &@mizchi/bit_types.RepoFileSystem
RepoFileSystem) -> Unit raise @mizchi/bit_object.GitError
GitError

Materialize commit_id under root, producing an exact checkout: paths tracked by a prior checkout that are absent from this commit are removed. rfs must observe the same filesystem as fs (callers pass the same concrete value as both trait views).

#
checkout_commit_to_fs_async

source

async fn[FS : @mizchi/bit_types.AsyncFileSystem
AsyncFileSystem + @mizchi/bit_types.AsyncRepoFileSystem
AsyncRepoFileSystem] checkout_commit_to_fs_async(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, fs : FS, root : String) -> Unit raise @mizchi/bit_object.GitError
GitError

Asynchronous counterpart to checkout_commit_to_fs.

#
is_gitlink_mode

source

fn is_gitlink_mode(mode : String) -> Bool

#
is_tree_mode

source

fn is_tree_mode(mode : String) -> Bool

#
join_path

source

fn join_path(root : String, path : String) -> String

#
materialize_clone_to_fs

source

fn materialize_clone_to_fs(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, refname : String, remote_url : String, fs : &@mizchi/bit_types.FileSystem
FileSystem, root : String, rfs : &@mizchi/bit_types.RepoFileSystem
RepoFileSystem) -> Unit raise @mizchi/bit_object.GitError
GitError

#
materialize_clone_to_fs_async

source

async fn[FS : @mizchi/bit_types.AsyncFileSystem
AsyncFileSystem + @mizchi/bit_types.AsyncRepoFileSystem
AsyncRepoFileSystem] materialize_clone_to_fs_async(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, refname : String, remote_url : String, fs : FS, root : String) -> Unit raise @mizchi/bit_object.GitError
GitError

Asynchronous counterpart to materialize_clone_to_fs.

#
parent_dir

source

fn parent_dir(path : String) -> String

#
parse_commit

source

fn parse_commit(content : Bytes) -> CommitInfo raise @mizchi/bit_object.GitError
GitError

#
parse_tree

source

fn parse_tree(content : Bytes) -> Array[@mizchi/bit_object.TreeEntry
TreeEntry] raise @mizchi/bit_object.GitError
GitError

#
read_shallow_boundaries

source

fn read_shallow_boundaries(fs : &@mizchi/bit_types.RepoFileSystem
RepoFileSystem, git_dir : String) -> Array[@mizchi/bit_object.ObjectId
ObjectId]

#
verify_tree_entry_name

source

fn verify_tree_entry_name(name : String) -> Unit raise @mizchi/bit_object.GitError
GitError

Verify a single tree-entry name is safe to materialize into a worktree path.

Rejects: empty string, ., .., any name containing / or NUL, and .git case-insensitively (the canonical foothold for hooks, config, refs). Mirrors the subset of git's verify_path() that matters for path-traversal during checkout / clone / fetch.

Called at the bytes→worktree boundary (walk_tree_to_fs, lib.collect_tree_files_inner). Reading the bytes via @object.parse_tree is unaffected: a repo might still contain legacy commits with names we now reject, but bit refuses to materialize them. Use git fsck --strict upstream to catch the commit; bit will not silently write into .git/ or above the worktree.

#
write_git_metadata

source

fn write_git_metadata(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, refname : String, remote_url : String, fs : &@mizchi/bit_types.FileSystem
FileSystem, root : String, rfs : &@mizchi/bit_types.RepoFileSystem
RepoFileSystem) -> Unit raise @mizchi/bit_object.GitError
GitError

#
write_git_metadata_async

source

async fn[FS : @mizchi/bit_types.AsyncFileSystem
AsyncFileSystem + @mizchi/bit_types.AsyncRepoFileSystem
AsyncRepoFileSystem] write_git_metadata_async(store : ObjectStore, commit_id : @mizchi/bit_object.ObjectId
ObjectId, refname : String, remote_url : String, fs : FS, root : String) -> Unit raise @mizchi/bit_object.GitError
GitError

Asynchronous counterpart to write_git_metadata.

Source Files

Site source Report issue Packages Build queue Skills Statistics

bit_repo

#CommitInfo

#ObjectStore

#ObjectStore::add_objects

#ObjectStore::contains

#ObjectStore::from_pack

#ObjectStore::get

#ObjectStore::new

#apply_shallow_updates

#checkout_commit

#checkout_commit_to_fs

#checkout_commit_to_fs_async

#is_gitlink_mode

#is_tree_mode

#join_path

#materialize_clone_to_fs

#materialize_clone_to_fs_async

#parent_dir

#parse_commit

#parse_tree

#read_shallow_boundaries

#verify_tree_entry_name

#write_git_metadata

#write_git_metadata_async

Source Files

#
CommitInfo

#
ObjectStore

#
ObjectStore::add_objects

#
ObjectStore::contains

#
ObjectStore::from_pack

#
ObjectStore::get

#
ObjectStore::new

#
apply_shallow_updates

#
checkout_commit

#
checkout_commit_to_fs

#
checkout_commit_to_fs_async

#
is_gitlink_mode

#
is_tree_mode

#
join_path

#
materialize_clone_to_fs

#
materialize_clone_to_fs_async

#
parent_dir

#
parse_commit

#
parse_tree

#
read_shallow_boundaries

#
verify_tree_entry_name

#
write_git_metadata

#
write_git_metadata_async