Struct BBClient 

pub struct BBClient {
    pub cache_folder: PathBuf,
    pub bedbase_api: String,
    /* private fields */
}

Client for managing BED file and BED set caching from BEDbase.

BBClient provides a high-level interface for:

• Downloading and caching BED files from the BEDbase API
• Managing local BED file collections
• Organizing BED sets (collections of related BED files)
• Querying and removing cached resources

The client maintains two separate caches:

• bedfile_cache: Individual BED files (stored as .bed.gz)
• bedset_cache: BED set metadata files (stored as .txt with lists of BED IDs)

Examples

use gtars_bbcache::client::BBClient;

// Create a client with default settings
let mut client = BBClient::builder().finish()?;

// Download and cache a BED file from BEDbase
let region_set = client.load_bed("6b2e163a1d4319d99bd465c6c78a9741")?;

// Check if file exists in cache
let path = client.seek("6b2e163a1d4319d99bd465c6c78a9741")?;
println!("Cached at: {:?}", path);

// List all cached BED files
let beds = client.list_beds()?;
println!("Found {} cached BED files", beds.len());

// Remove from cache
client.remove("6b2e163a1d4319d99bd465c6c78a9741")?;

Fields

cache_folder: PathBuf

Path to the root cache directory

bedbase_api: String

BEDbase API endpoint URL

Implementations

impl BBClient

pub fn builder() -> BBClientBuilder

Creates a new builder for constructing a BBClient.

The builder pattern allows you to configure the cache folder and API endpoint before creating the client instance.

Examples

use gtars_bbcache::client::BBClient;
use std::path::PathBuf;

let client = BBClient::builder()
    .with_cache_folder(PathBuf::from("/tmp/bbcache"))
    .finish()?;

pub fn load_bed(&mut self, bed_id: &str) -> Result<RegionSet>

Loads a BED file from cache, or downloads and caches it if it doesn’t exist

Arguments

• bed_id: unique identifier of a BED file

Returns

• the RegionSet object of the loaded bed file

pub fn load_bedset(&mut self, bedset_id: &str) -> Result<RegionSetList>

Load a BEDset from cache, or download and add it to the cache with its BED files

Arguments

• bedset_id: unique identifier of a BED set

Returns

• the RegionSetList object of the loaded bed set

pub fn add_local_bed_to_cache( &mut self, bedfile: PathBuf, force: Option<bool>, ) -> Result<String>

Add a BED file to the cache

Arguments

• bedfile: a path or url to the BED file
• force: whether to overwrite the existing file in cache

Returns

• the RegionSet identifier

pub fn add_regionset_to_cache( &mut self, regionset: RegionSet, force: Option<bool>, ) -> Result<String>

Add a RegionSet object to the cache

Arguments

• regionset: a RegionSet object
• force: whether to overwrite the existing file in cache

Returns

• the RegionSet identifier

pub fn add_bedset_to_cache(&mut self, bedset: RegionSetList) -> Result<String>

Add a BED set to the cache

Arguments

• bedset: the BED set to be added, a RegionSetList class

Returns

• the identifier if the RegionSetList object

pub fn add_local_folder_as_bedset( &mut self, folder_path: PathBuf, ) -> Result<String>

Add a folder of bed files to the cache as a bedset

Arguments

• folder_path: path to the folder where bed files are stored

Returns

• the identifier if the RegionSetList object

pub fn add_local_file_as_bedset(&mut self, file_path: PathBuf) -> Result<String>

Add a local file that contains bed file paths as a bed set

Arguments

• file_path: path to the file of bedset info

Returns

• the identifier if the RegionSetList object

pub fn seek(&self, identifier: &str) -> Result<PathBuf>

Get local path to BED file or BED set with specific identifier

Arguments

• identifier: the unique identifier

Returns

• the local path of the file

pub fn remove(&mut self, identifier: &str) -> Result<()>

Remove a BED file or BED set from the cache folder as well as biocfilcache (SQLite)

Arguments

• identifier: the identifier of BED file / BED set to be removed

pub fn list_beds(&mut self) -> Result<Vec<Resource>>

List identifiers and paths of all BED files in cache

Returns

• the list of resource stored in biocfilecache (identifiers & paths)

pub fn list_bedsets(&mut self) -> Result<Vec<Resource>>

List identifiers and paths of all BED sets in cache

Returns

• the list of resource stored in biocfilecache (identifiers & paths)