Crate htsget_search

Crate htsget_search 

Source
Expand description

Module providing a representation of the HtsGet specification.

Based on the HtsGet Specification.

Modules§

bam_search
Module providing the search capability using BAM/BAI files
bcf_search
Module providing the search capability using BCF files
cram_search
This module provides search capabilities for CRAM files.
from_storage
Module providing an implementation of the HtsGet trait using a [StorageTrait].
search
The following file defines commonalities between all the file formats. While each format has its own particularities, there are many shared components that can be abstracted.
vcf_search
Module providing the search capability using VCF files

Structs§

Config
Simplified config.
FileStorage
Implementation for the StorageTrait trait using the local file system. [T] is the type of the server struct, which is used for formatting urls.
Headers
The headers that need to be supplied when requesting data from a url.
JsonResponse
Wrapped json response for htsget.
Query
A query contains all the parameters that can be used when requesting a search for either of reads or variants.
Response
The response for a HtsGet query.
Storage
The top-level storage type is created from any StorageTrait.
Url
A url from which raw data can be retrieved.

Enums§

Class
Class component of htsget response.
Format
An enumeration with all the possible formats.
HtsGetError
Htsget specific errors.

Traits§

HtsGet
Trait representing a search for either reads or variants in the HtsGet specification.
IdResolver
A trait which matches the query id, replacing the match in the substitution text.
ResolveResponse
A trait for determining the response from Storage.
StorageResolver
A trait which uses storage to resolve requests into responses.

Type Aliases§

Result
The result type returning a HtsGetError.