README
U
AsyncFileSystem
U
AsyncHttpClient
U
AsyncRepoFileSystem
U
Commit
U
CommitInfo
U
FileSystem
U
GitError
U
HashAlgorithm
U
HashState
U
HttpClient
U
HttpResponse
U
MockHttpClient
U
ObjectId
U
ObjectStore
U
ObjectType
U
PackCompression
U
PackDeltaMode
U
PackObject
U
RepoFileSystem
U
Sha1State
U
Sha256State
U
TestFs
U
TreeEntry
V
checkout_commit
V
checkout_commit_to_fs
V
checkout_commit_to_fs_async
V
create_blob
V
create_blob_string
V
create_commit
V
create_object
V
create_tree
V
hash_array_prefix
V
hash_blob
V
hash_blob_string
V
hash_object_content
V
hash_object_content_with_algo
V
hash_prefix
V
join_path
V
materialize_clone_to_fs
V
materialize_clone_to_fs_async
V
parse_commit
V
parse_tree
V
serialize_commit_content
V
serialize_tree
V
sha1
V
sha1_array
V
sha1_array_prefix
V
sha1_prefix
V
sha256_array_prefix
V
sha256_prefix
V
verify_tree_entry_name
V
write_git_metadata
V
write_git_metadata_async

bit_core

Stable core facade for bit's internal Git primitives

git

core

facade

Download zip

Author

mizchi

Version

0.47.0

License

Apache-2.0

Repository

github.com/mizchi/bit-vcs

Last updated

13 days ago

Downloads

Dependencies

#bit_core

Stable internal facade shared by the publishable bit modules.

AsyncFileSystem

source

using @mizchi/bit_types { trait AsyncFileSystem }

Stable core facade for workspace modules.

AsyncHttpClient

source

using @mizchi/bit_types { trait AsyncHttpClient }

Stable core facade for workspace modules.

AsyncRepoFileSystem

source

using @mizchi/bit_types { trait AsyncRepoFileSystem }

Stable core facade for workspace modules.

Commit

source

using @mizchi/bit_object { type Commit }

Git commit object

CommitInfo

source

using @mizchi/bit_repo { type CommitInfo }

FileSystem

source

using @mizchi/bit_types { trait FileSystem }

Stable core facade for workspace modules.

GitError

source

using @mizchi/bit_object { type GitError }

Git operation errors

HashAlgorithm

source

using @mizchi/bit_object { type HashAlgorithm }

HashState

source

using @mizchi/bit_object { type HashState }

HttpClient

source

using @mizchi/bit_types { trait HttpClient }

Stable core facade for workspace modules.

HttpResponse

source

using @mizchi/bit_types { type HttpResponse }

Stable core facade for workspace modules.

MockHttpClient

source

using @mizchi/bit_types { type MockHttpClient }

Stable core facade for workspace modules.

ObjectId

source

using @mizchi/bit_object { type ObjectId }

Object identifier (20 bytes for SHA-1, 32 bytes for SHA-256)

ObjectStore

source

using @mizchi/bit_repo { type ObjectStore }

ObjectType

source

using @mizchi/bit_object { type ObjectType }

Git object types

PackCompression

source

using @mizchi/bit_object { type PackCompression }

Compression mode for packfile entries

PackDeltaMode

source

using @mizchi/bit_object { type PackDeltaMode }

Delta encoding mode for packfile generation

PackObject

source

using @mizchi/bit_object { type PackObject }

A Git object ready for packing

RepoFileSystem

source

using @mizchi/bit_types { trait RepoFileSystem }

Stable core facade for workspace modules.

Sha1State

source

using @mizchi/bit_object { type Sha1State }

Sha256State

source

using @mizchi/bit_object { type Sha256State }

TestFs

source

using @mizchi/bit_io { type TestFs }

TreeEntry

source

using @mizchi/bit_object { type TreeEntry }

Tree entry in a Git tree object

checkout_commit

source

fn checkout_commit(store : @mizchi/bit_repo.ObjectStore
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 : @mizchi/bit_repo.ObjectStore
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 : @mizchi/bit_repo.ObjectStore
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.

create_blob

source

fn create_blob(content : Bytes) -> (@mizchi/bit_object.ObjectId
ObjectId, Bytes)

Create a blob object from content

create_blob_string

source

fn create_blob_string(content : String) -> (@mizchi/bit_object.ObjectId
ObjectId, Bytes)

Create a blob from string content

create_commit

source

fn create_commit(commit : @mizchi/bit_object.Commit
Commit) -> (@mizchi/bit_object.ObjectId
ObjectId, Bytes)

Create a commit object

create_object

source

fn create_object(obj_type : @mizchi/bit_object.ObjectType
ObjectType, content : Bytes) -> (@mizchi/bit_object.ObjectId
ObjectId, Bytes)

Create a Git object and return its ID and compressed data Format: {type} {size}\0{content} -> SHA-1 -> zlib compress

create_tree

source

fn create_tree(entries : Array[@mizchi/bit_object.TreeEntry
TreeEntry]) -> (@mizchi/bit_object.ObjectId
ObjectId, Bytes)

Create a tree object from entries Entries must be sorted by name

hash_array_prefix

source

fn hash_array_prefix(data : Array[Byte], len : Int, hash_size? : Int) -> @mizchi/bit_object.ObjectId
ObjectId

Hash Array prefix (first len bytes), dispatching by hash_size.

hash_blob

source

fn hash_blob(content : Bytes) -> @mizchi/bit_object.ObjectId
ObjectId

Hash a blob without creating the compressed object - optimized with incremental SHA1

hash_blob_string

source

fn hash_blob_string(content : String) -> @mizchi/bit_object.ObjectId
ObjectId

Hash a blob from string - optimized with incremental SHA1

hash_object_content

source

fn hash_object_content(obj_type : @mizchi/bit_object.ObjectType
ObjectType, content : Bytes) -> @mizchi/bit_object.ObjectId
ObjectId

Hash object content (without compression) - optimized with incremental SHA1

hash_object_content_with_algo

source

fn hash_object_content_with_algo(algo : @mizchi/bit_object.HashAlgorithm
HashAlgorithm, obj_type : @mizchi/bit_object.ObjectType
ObjectType, content : Bytes) -> @mizchi/bit_object.ObjectId
ObjectId

Hash object content using the specified algorithm.

hash_prefix

source

fn hash_prefix(data : Bytes, len : Int, hash_size? : Int) -> @mizchi/bit_object.ObjectId
ObjectId

Hash data prefix (first len bytes), dispatching by hash_size.

join_path

source

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

materialize_clone_to_fs

source

fn materialize_clone_to_fs(store : @mizchi/bit_repo.ObjectStore
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 : @mizchi/bit_repo.ObjectStore
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.

parse_commit

source

fn parse_commit(content : Bytes) -> @mizchi/bit_repo.CommitInfo
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

serialize_commit_content

source

fn serialize_commit_content(commit : @mizchi/bit_object.Commit
Commit) -> Bytes

Serialize commit to raw content bytes (without git object header)

serialize_tree

source

fn serialize_tree(entries : Array[@mizchi/bit_object.TreeEntry
TreeEntry]) -> Bytes

Serialize tree entries to raw content bytes (without git object header)

sha1

source

fn sha1(data : Bytes) -> @mizchi/bit_object.ObjectId
ObjectId

Compute SHA-1 hash of data

sha1_array

source

fn sha1_array(data : Array[Byte]) -> @mizchi/bit_object.ObjectId
ObjectId

Compute SHA-1 hash of data from Array

sha1_array_prefix

source

fn sha1_array_prefix(data : Array[Byte], len : Int) -> @mizchi/bit_object.ObjectId
ObjectId

Compute SHA-1 hash of Array prefix (first len bytes).

sha1_prefix

source

fn sha1_prefix(data : Bytes, len : Int) -> @mizchi/bit_object.ObjectId
ObjectId

Compute SHA-1 hash of data prefix (first len bytes).

sha256_array_prefix

source

fn sha256_array_prefix(data : Array[Byte], len : Int) -> @mizchi/bit_object.ObjectId
ObjectId

sha256_prefix

source

fn sha256_prefix(data : Bytes, len : Int) -> @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 : @mizchi/bit_repo.ObjectStore
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 : @mizchi/bit_repo.ObjectStore
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

top.mbt

Site source Report issue Packages Build queue Skills Statistics

bit_core

#bit_core

#AsyncFileSystem

#AsyncHttpClient

#AsyncRepoFileSystem

#Commit

#CommitInfo

#FileSystem

#GitError

#HashAlgorithm

#HashState

#HttpClient

#HttpResponse

#MockHttpClient

#ObjectId

#ObjectStore

#ObjectType

#PackCompression

#PackDeltaMode

#PackObject

#RepoFileSystem

#Sha1State

#Sha256State

#TestFs

#TreeEntry

#checkout_commit

#checkout_commit_to_fs

#checkout_commit_to_fs_async

#create_blob

#create_blob_string

#create_commit

#create_object

#create_tree

#hash_array_prefix

#hash_blob

#hash_blob_string

#hash_object_content

#hash_object_content_with_algo

#hash_prefix

#join_path

#materialize_clone_to_fs

#materialize_clone_to_fs_async

#parse_commit

#parse_tree

#serialize_commit_content

#serialize_tree

#sha1

#sha1_array

#sha1_array_prefix

#sha1_prefix

#sha256_array_prefix

#sha256_prefix

#verify_tree_entry_name

#write_git_metadata

#write_git_metadata_async

Source Files

AsyncFileSystem

AsyncHttpClient

AsyncRepoFileSystem

Commit

CommitInfo

FileSystem

GitError

HashAlgorithm

HashState

HttpClient

HttpResponse

MockHttpClient

ObjectId

ObjectStore

ObjectType

PackCompression

PackDeltaMode

PackObject

RepoFileSystem

Sha1State

Sha256State

TestFs

TreeEntry

checkout_commit

checkout_commit_to_fs

checkout_commit_to_fs_async

create_blob

create_blob_string

create_commit

create_object

create_tree

hash_array_prefix

hash_blob

hash_blob_string

hash_object_content

hash_object_content_with_algo

hash_prefix

join_path

materialize_clone_to_fs

materialize_clone_to_fs_async

parse_commit

parse_tree

serialize_commit_content

serialize_tree

sha1

sha1_array

sha1_array_prefix

sha1_prefix

sha256_array_prefix

sha256_prefix

verify_tree_entry_name

write_git_metadata

write_git_metadata_async