mizchi/bit/object - mooncakes.io

README
U
Commit
U
CommitInfo
U
FileSystem
U
GitError
U
HttpClient
U
HttpResponse
U
MockHttpClient
U
ObjectId
U
ObjectStore
U
ObjectType
U
PackCompression
U
PackDeltaMode
U
PackObject
U
RepoFileSystem
U
Sha1State
U
TestFs
U
TreeEntry
V
checkout_commit
V
checkout_commit_to_fs
V
create_blob
V
create_blob_string
V
create_commit
V
create_object
V
create_tree
V
hash_blob
V
hash_blob_string
V
hash_object_content
V
join_path
V
materialize_clone_to_fs
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
write_git_metadata

mizchi/bit/object does not have a README file

GitError

pub(all) suberror GitError {
  InvalidObject(String)
  HashMismatch(String, String)
  PackfileError(String)
  ProtocolError(String)
  IoError(String)
}

Git operation errors

impl Eq for GitError

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
}

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) -> Commit

ObjectId

source

pub struct ObjectId {
  bytes : FixedArray[Byte]
}

SHA-1 object identifier (20 bytes)

impl Eq for ObjectId

impl Hash for ObjectId

impl Show for ObjectId

ObjectId::from_bytes

source

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

Create ObjectId from Bytes (must be exactly 20 bytes)

ObjectId::from_bytes_at

source

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

Create ObjectId from Bytes at offset (for parsing packed data)

ObjectId::from_hex

source

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

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 (20 bytes) - zero-copy when possible

ObjectId::to_hex

source

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

ObjectId::zero

source

fn ObjectId::zero() -> ObjectId

ObjectType

source

pub(all) enum ObjectType {
  Blob
  Tree
  Commit
  Tag
}

Git object types

impl Eq for ObjectType

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

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

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_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_tree

source

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

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

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

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).

Source Files

Site source Report issue Packages Build queue Skills Statistics

#GitError

#Commit

#Commit::new

#ObjectId

#ObjectId::from_bytes

#ObjectId::from_bytes_at

#ObjectId::from_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

#TreeEntry

#TreeEntry::new

#create_blob

#create_blob_string

#create_commit

#create_object

#create_tree

#hash_blob

#hash_blob_string

#hash_object_content

#serialize_commit_content

#serialize_tree

#sha1

#sha1_array

#sha1_array_prefix

#sha1_prefix

Source Files

GitError

Commit

Commit::new

ObjectId

ObjectId::from_bytes

ObjectId::from_bytes_at

ObjectId::from_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

TreeEntry

TreeEntry::new

create_blob

create_blob_string

create_commit

create_object

create_tree

hash_blob

hash_blob_string

hash_object_content

serialize_commit_content

serialize_tree

sha1

sha1_array

sha1_array_prefix

sha1_prefix