README
E
GitError
- ::newCommit::new
- ::from_stringHashAlgorithm::from_string
- ::hash_sizeHashAlgorithm::hash_size
- ::hex_sizeHashAlgorithm::hex_size
- ::nameHashAlgorithm::name
- ::zero_hexHashAlgorithm::zero_hex
- ::finishHashState::finish
- ::newHashState::new
- ::resetHashState::reset
- ::updateHashState::update
- ::update_byteHashState::update_byte
- ::update_sliceHashState::update_slice
- ::update_stringHashState::update_string
- ::from_bytesObjectId::from_bytes
- ::from_bytes_atObjectId::from_bytes_at
- ::from_hexObjectId::from_hex
- ::hash_sizeObjectId::hash_size
- ::is_zeroObjectId::is_zero
- ::is_zero_hexObjectId::is_zero_hex
- ::newObjectId::new
- ::to_bytesObjectId::to_bytes
- ::to_hexObjectId::to_hex
- ::zeroObjectId::zero
- ::to_packfile_typeObjectType::to_packfile_type
- ::to_stringObjectType::to_string
T
PackCompression
T
PackDeltaMode
- ::newPackObject::new
- ::with_metadataPackObject::with_metadata
- ::finishSha1State::finish
- ::newSha1State::new
- ::resetSha1State::reset
- ::updateSha1State::update
- ::update_byteSha1State::update_byte
- ::update_sliceSha1State::update_slice
- ::update_stringSha1State::update_string
- ::finishSha256State::finish
- ::newSha256State::new
- ::resetSha256State::reset
- ::updateSha256State::update
- ::update_byteSha256State::update_byte
- ::update_sliceSha256State::update_slice
- ::update_stringSha256State::update_string
- ::newTreeEntry::new
V
array_to_bytes
V
create_blob
V
create_blob_string
V
create_commit
V
create_commit_with_algo
V
create_object
V
create_object_with_algo
V
create_tree
V
create_tree_with_algo
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
serialize_commit_content
V
serialize_tree
V
sha1
V
sha1_array
V
sha1_array_prefix
V
sha1_prefix
V
sha256
V
sha256_array
V
sha256_array_prefix
V
sha256_prefix

bit_object

Git object model (gix-object equivalent)

git

object

blob

tree

commit

Download zip

Author

mizchi

Version

0.47.0

License

Apache-2.0

Repository

github.com/mizchi/bit-vcs

Last updated

7 hours ago

Downloads

904

Dependencies

mizchi/bit_hash0.47.0
mizchi/zlib0.4.9

GitError

source

pub(all) suberror GitError {
  InvalidObject(String)
  HashMismatch(String, String)
  PackfileError(String)
  ProtocolError(String)
  IoError(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Git operation errors

impl Show for GitError

Commit

source

pub struct Commit {
  tree : ObjectId
  parents : Array[ObjectId]
  author : String
  author_time : Int64
  author_tz : String
  committer : String
  commit_time : Int64
  committer_tz : String
  message : String
  encoding : String
  verbatim_message : Bool
}

Git commit object

Commit::new

source

fn Commit::new(tree : ObjectId, parents : Array[ObjectId], author : String, author_time : Int64, author_tz : String, committer : String, commit_time : Int64, committer_tz : String, message : String, encoding? : String, verbatim_message? : Bool) -> Commit

HashAlgorithm

source

pub(all) enum HashAlgorithm {
  Sha1
  Sha256
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

impl Show for HashAlgorithm

HashAlgorithm::from_string

source

fn HashAlgorithm::from_string(s : String) -> HashAlgorithm raise GitError

HashAlgorithm::hash_size

source

fn HashAlgorithm::hash_size(self : HashAlgorithm) -> Int

HashAlgorithm::hex_size

source

fn HashAlgorithm::hex_size(self : HashAlgorithm) -> Int

HashAlgorithm::name

source

fn HashAlgorithm::name(self : HashAlgorithm) -> String

HashAlgorithm::zero_hex

source

fn HashAlgorithm::zero_hex(self : HashAlgorithm) -> String

HashState

source

pub(all) enum HashState {
  HS1(Sha1State)
  HS256(Sha256State)
}

HashState::finish

source

fn HashState::finish(self : HashState) -> ObjectId

HashState::new

source

fn HashState::new(algo : HashAlgorithm) -> HashState

HashState::reset

source

fn HashState::reset(self : HashState) -> Unit

HashState::update

source

fn HashState::update(self : HashState, data : Bytes) -> Unit

HashState::update_byte

source

fn HashState::update_byte(self : HashState, b : Byte) -> Unit

HashState::update_slice

source

fn HashState::update_slice(self : HashState, data : Bytes, offset : Int, len : Int) -> Unit

HashState::update_string

source

fn HashState::update_string(self : HashState, s : String) -> Unit

ObjectId

source

pub struct ObjectId {
  bytes : FixedArray[Byte]
}

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

impl Eq for ObjectId

impl Hash for ObjectId

impl Show for ObjectId

impl Debug for ObjectId

ObjectId::from_bytes

source

fn ObjectId::from_bytes(data : Bytes) -> ObjectId raise GitError

Create ObjectId from Bytes (must be exactly 20 or 32 bytes)

ObjectId::from_bytes_at

source

fn ObjectId::from_bytes_at(data : Bytes, offset : Int, hash_size? : Int) -> ObjectId

Create ObjectId from Bytes at offset (for parsing packed data). Reads hash_size bytes (default 20 for SHA-1).

ObjectId::from_hex

source

fn ObjectId::from_hex(hex : String) -> ObjectId raise GitError

ObjectId::hash_size

source

fn ObjectId::hash_size(self : ObjectId) -> Int

Return the byte length of this ObjectId (20 for SHA-1, 32 for SHA-256).

ObjectId::is_zero

source

fn ObjectId::is_zero(self : ObjectId) -> Bool

Check if this ObjectId is the zero (null) object id.

ObjectId::is_zero_hex

source

fn ObjectId::is_zero_hex(hex : String) -> Bool

Check if a hex string represents the zero (null) object id.

ObjectId::new

source

fn ObjectId::new(bytes : FixedArray[Byte]) -> ObjectId

ObjectId::to_bytes

source

fn ObjectId::to_bytes(self : ObjectId) -> Bytes

Convert ObjectId to Bytes - zero-copy when possible

ObjectId::to_hex

source

fn ObjectId::to_hex(self : ObjectId) -> String

ObjectId::zero

source

fn ObjectId::zero(algo? : HashAlgorithm) -> ObjectId

ObjectType

source

pub(all) enum ObjectType {
  Blob
  Tree
  Commit
  Tag
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Git object types

impl Show for ObjectType

ObjectType::to_packfile_type

source

fn ObjectType::to_packfile_type(self : ObjectType) -> Int

ObjectType::to_string

source

fn ObjectType::to_string(self : ObjectType) -> String

PackCompression

source

pub(all) enum PackCompression {
  Default
  Stored
}

Compression mode for packfile entries

PackDeltaMode

source

pub(all) enum PackDeltaMode {
  NoDelta
  RefDelta
  OfsDelta
}

Delta encoding mode for packfile generation

PackObject

source

pub struct PackObject {
  obj_type : ObjectType
  data : Bytes
  id : ObjectId
  offset : Int
  crc32 : UInt
}

A Git object ready for packing

PackObject::new

source

fn PackObject::new(obj_type : ObjectType, data : Bytes) -> PackObject

PackObject::with_metadata

source

fn PackObject::with_metadata(obj_type : ObjectType, data : Bytes, id : ObjectId, offset : Int, crc32 : UInt) -> PackObject

Sha1State

source

pub struct Sha1State {
  inner : @mizchi/bit_hash.Sha1State
Sha1State
}

Sha1State::finish

source

fn Sha1State::finish(self : Sha1State) -> ObjectId

Sha1State::new

source

fn Sha1State::new() -> Sha1State

Sha1State::reset

source

fn Sha1State::reset(self : Sha1State) -> Unit

Sha1State::update

source

fn Sha1State::update(self : Sha1State, data : Bytes) -> Unit

Sha1State::update_byte

source

fn Sha1State::update_byte(self : Sha1State, b : Byte) -> Unit

Sha1State::update_slice

source

fn Sha1State::update_slice(self : Sha1State, data : Bytes, offset : Int, len : Int) -> Unit

Sha1State::update_string

source

fn Sha1State::update_string(self : Sha1State, s : String) -> Unit

Sha256State

source

pub struct Sha256State {
  inner : @mizchi/bit_hash.Sha256State
Sha256State
}

Sha256State::finish

source

fn Sha256State::finish(self : Sha256State) -> ObjectId

Sha256State::new

source

fn Sha256State::new() -> Sha256State

Sha256State::reset

source

fn Sha256State::reset(self : Sha256State) -> Unit

Sha256State::update

source

fn Sha256State::update(self : Sha256State, data : Bytes) -> Unit

Sha256State::update_byte

source

fn Sha256State::update_byte(self : Sha256State, b : Byte) -> Unit

Sha256State::update_slice

source

fn Sha256State::update_slice(self : Sha256State, data : Bytes, offset : Int, len : Int) -> Unit

Sha256State::update_string

source

fn Sha256State::update_string(self : Sha256State, s : String) -> Unit

TreeEntry

source

pub struct TreeEntry {
  mode : String
  name : String
  id : ObjectId
}

Tree entry in a Git tree object

TreeEntry::new

source

fn TreeEntry::new(mode : String, name : String, id : ObjectId) -> TreeEntry

array_to_bytes

source

fn array_to_bytes(arr : Array[Byte]) -> Bytes

Helper to convert Array[Byte] to Bytes

create_blob

source

fn create_blob(content : Bytes) -> (ObjectId, Bytes)

Create a blob object from content

create_blob_string

source

fn create_blob_string(content : String) -> (ObjectId, Bytes)

Create a blob from string content

create_commit

source

fn create_commit(commit : Commit) -> (ObjectId, Bytes)

Create a commit object

create_commit_with_algo

source

fn create_commit_with_algo(algo : HashAlgorithm, commit : Commit) -> (ObjectId, Bytes)

create_object

source

fn create_object(obj_type : ObjectType, content : Bytes) -> (ObjectId, Bytes)

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

create_object_with_algo

source

fn create_object_with_algo(algo : HashAlgorithm, obj_type : ObjectType, content : Bytes) -> (ObjectId, Bytes)

Create a git object (hash + compress) using the specified algorithm.

create_tree

source

fn create_tree(entries : Array[TreeEntry]) -> (ObjectId, Bytes)

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

create_tree_with_algo

source

fn create_tree_with_algo(algo : HashAlgorithm, entries : Array[TreeEntry]) -> (ObjectId, Bytes)

hash_array_prefix

source

fn hash_array_prefix(data : Array[Byte], len : Int, hash_size? : Int) -> ObjectId

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

hash_blob

source

fn hash_blob(content : Bytes) -> ObjectId

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

hash_blob_string

source

fn hash_blob_string(content : String) -> ObjectId

Hash a blob from string - optimized with incremental SHA1

hash_object_content

source

fn hash_object_content(obj_type : ObjectType, content : Bytes) -> ObjectId

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

hash_object_content_with_algo

source

fn hash_object_content_with_algo(algo : HashAlgorithm, obj_type : ObjectType, content : Bytes) -> ObjectId

Hash object content using the specified algorithm.

hash_prefix

source

fn hash_prefix(data : Bytes, len : Int, hash_size? : Int) -> ObjectId

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

serialize_commit_content

source

fn serialize_commit_content(commit : Commit) -> Bytes

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

serialize_tree

source

fn serialize_tree(entries : Array[TreeEntry]) -> Bytes

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

sha1

source

fn sha1(data : Bytes) -> ObjectId

Compute SHA-1 hash of data

sha1_array

source

fn sha1_array(data : Array[Byte]) -> ObjectId

Compute SHA-1 hash of data from Array

sha1_array_prefix

source

fn sha1_array_prefix(data : Array[Byte], len : Int) -> ObjectId

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

sha1_prefix

source

fn sha1_prefix(data : Bytes, len : Int) -> ObjectId

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

sha256

source

fn sha256(data : Bytes) -> ObjectId

sha256_array

source

fn sha256_array(data : Array[Byte]) -> ObjectId

sha256_array_prefix

source

fn sha256_array_prefix(data : Array[Byte], len : Int) -> ObjectId

sha256_prefix

source

fn sha256_prefix(data : Bytes, len : Int) -> ObjectId

Source Files

Site source Report issue Packages Build queue Skills Statistics

bit_object

#GitError

#Commit

#Commit::new

#HashAlgorithm

#HashAlgorithm::from_string

#HashAlgorithm::hash_size

#HashAlgorithm::hex_size

#HashAlgorithm::name

#HashAlgorithm::zero_hex

#HashState

#HashState::finish

#HashState::new

#HashState::reset

#HashState::update

#HashState::update_byte

#HashState::update_slice

#HashState::update_string

#ObjectId

#ObjectId::from_bytes

#ObjectId::from_bytes_at

#ObjectId::from_hex

#ObjectId::hash_size

#ObjectId::is_zero

#ObjectId::is_zero_hex

#ObjectId::new

#ObjectId::to_bytes

#ObjectId::to_hex

#ObjectId::zero

#ObjectType

#ObjectType::to_packfile_type

#ObjectType::to_string

#PackCompression

#PackDeltaMode

#PackObject

#PackObject::new

#PackObject::with_metadata

#Sha1State

#Sha1State::finish

#Sha1State::new

#Sha1State::reset

#Sha1State::update

#Sha1State::update_byte

#Sha1State::update_slice

#Sha1State::update_string

#Sha256State

#Sha256State::finish

#Sha256State::new

#Sha256State::reset

#Sha256State::update

#Sha256State::update_byte

#Sha256State::update_slice

#Sha256State::update_string

#TreeEntry

#TreeEntry::new

#array_to_bytes

#create_blob

#create_blob_string

#create_commit

#create_commit_with_algo

#create_object

#create_object_with_algo

#create_tree

#create_tree_with_algo

#hash_array_prefix

#hash_blob

#hash_blob_string

#hash_object_content

#hash_object_content_with_algo

#hash_prefix

#serialize_commit_content

#serialize_tree

#sha1

#sha1_array

#sha1_array_prefix

#sha1_prefix

#sha256

#sha256_array

#sha256_array_prefix

#sha256_prefix

GitError

Commit

Commit::new

HashAlgorithm

HashAlgorithm::from_string

HashAlgorithm::hash_size

HashAlgorithm::hex_size

HashAlgorithm::name

HashAlgorithm::zero_hex

HashState

HashState::finish

HashState::new

HashState::reset

HashState::update

HashState::update_byte

HashState::update_slice

HashState::update_string

ObjectId

ObjectId::from_bytes

ObjectId::from_bytes_at

ObjectId::from_hex

ObjectId::hash_size

ObjectId::is_zero

ObjectId::is_zero_hex

ObjectId::new

ObjectId::to_bytes

ObjectId::to_hex

ObjectId::zero

ObjectType

ObjectType::to_packfile_type

ObjectType::to_string

PackCompression

PackDeltaMode

PackObject

PackObject::new

PackObject::with_metadata

Sha1State

Sha1State::finish

Sha1State::new

Sha1State::reset

Sha1State::update

Sha1State::update_byte

Sha1State::update_slice

Sha1State::update_string

Sha256State

Sha256State::finish

Sha256State::new

Sha256State::reset

Sha256State::update

Sha256State::update_byte

Sha256State::update_slice

Sha256State::update_string

TreeEntry

TreeEntry::new

array_to_bytes

create_blob

create_blob_string

create_commit

create_commit_with_algo

create_object

create_object_with_algo

create_tree

create_tree_with_algo

hash_array_prefix

hash_blob

hash_blob_string

hash_object_content

hash_object_content_with_algo

hash_prefix

serialize_commit_content

serialize_tree

sha1

sha1_array

sha1_array_prefix

sha1_prefix

sha256

sha256_array

sha256_array_prefix

sha256_prefix