Struct RefsTable 

pub struct RefsTable { /* private fields */ }

The refs table — manages branches and HEAD.

Implementations

impl RefsTable

pub fn new() -> Self

Create a new refs table with a “main” branch (no commit yet).

pub fn init_main(&mut self, commit_id: &str)

Initialize with a first commit on “main”.

pub fn head(&self) -> Option<&Ref>

Get the current HEAD ref.

pub fn get(&self, name: &str) -> Option<&Ref>

Get a ref by name.

pub fn resolve(&self, name: &str) -> Option<&str>

Get the commit ID for a ref name.

pub fn create_branch( &mut self, name: &str, commit_id: &str, ) -> Result<(), RefsError>

Create a new branch at the given commit.

pub fn switch_head(&mut self, name: &str) -> Result<(), RefsError>

Switch HEAD to a different branch.

pub fn update_ref( &mut self, name: &str, commit_id: &str, ) -> Result<(), RefsError>

Update a branch to point to a new commit.

Tags are immutable and cannot be updated — use create_tag instead.

pub fn delete_branch(&mut self, name: &str) -> Result<(), RefsError>

Delete a branch by name.

Cannot delete the HEAD branch. Cannot delete a nonexistent branch. Deleting a branch does NOT delete the commits it pointed to.

pub fn create_tag( &mut self, name: &str, commit_id: &str, ) -> Result<(), RefsError>

Create an immutable tag pointing to a commit.

Tags cannot be overwritten or moved once created.

pub fn tags(&self) -> Vec<&Ref>

List all tags.

pub fn branches(&self) -> Vec<&Ref>

List all branches.

pub fn to_record_batch(&self) -> Result<RecordBatch, ArrowError>

Convert to Arrow RecordBatch.

Trait Implementations

impl Default for RefsTable

fn default() -> Self

Returns the “default value” for a type.