htsget-http

Crates.iohtsget-http
lib.rshtsget-http
version0.5.1
sourcesrc
created_at2023-01-06 05:36:30.136246
updated_at2024-10-17 01:18:27.492777
descriptionCrate for handling HTTP in htsget-rs.
homepagehttps://github.com/umccr/htsget-rs/blob/main/htsget-http/README.md
repositoryhttps://github.com/umccr/htsget-rs
max_upload_size
id752093
size44,033
Marko Malenic (mmalenic)

documentation

https://github.com/umccr/htsget-rs/blob/main/htsget-http/README.md

README

htsget-http

MIT licensed Build Status

Framework independent code for handling HTTP in htsget-rs.

Overview

This crate handles all the framework independent code for htsget-rs, it:

  • Produces htsget-specific HTTP responses.
  • Converts query results to JSON HTTP responses.
  • Handles htsget client error reporting.
  • Uses htsget-search to calculate URL tickets and byte ranges.

Usage

For running htsget-rs as an application

There is no need to interact with this crate for running htsget-rs.

As a library

This crate is useful for implementing additional framework dependent versions of the htsget-rs server. For example, htsget-rs could be written using another framework such as warp. This crate provides functions like get, post and get_service_info_json for this purpose. These functions take query and endpoint information, and process it using htsget-search to return JSON HTTP responses.

Feature flags

This crate has the following features:

  • s3-storage: used to enable S3Storage functionality.
  • url-storage: used to enable UrlStorage functionality.
  • experimental: used to enable experimental features that aren't necessarily part of the htsget spec, such as Crypt4GH support through C4GHStorage.

License

This project is licensed under the MIT license.

Commit count: 783

cargo fmt