seqan3::detail::bgzf_compression Struct Reference

A tag signifying a bgzf compressed file. More...

#include <seqan3/io/detail/magic_header.hpp>

Static Public Member Functions
template<typename char_t , size_t extend>
static bool	validate_header (std::span< char_t, extend > header)
	Checks if the given header is a bgzf header.

Static Public Attributes
static std::vector< std::string >	file_extensions {{"bgzf"}}
	The valid file extension for bgzf compression.
static constexpr std::array< char, 18 >	magic_header
	The magic byte sequence to disambiguate bgzf compressed files.

Detailed Description

A tag signifying a bgzf compressed file.

Member Function Documentation

validate_header()

template<typename char_t , size_t extend>

static bool seqan3::detail::bgzf_compression::validate_header ( std::span< char_t, extend >  header )

inlinestatic

Checks if the given header is a bgzf header.

Parameters

[in]

header

The header to validate.

Returns

true if it is a bgzf header, otherwise false.

Member Data Documentation

magic_header

constexpr std::array<char, 18> seqan3::detail::bgzf_compression::magic_header

staticconstexpr

Initial value:

{
        
        gz_compression::magic_header[0],
        gz_compression::magic_header[1],
        gz_compression::magic_header[2],
        
        '\x04',
        '\x00',
        '\x00',
        '\x00',
        '\x00',
        '\x00',
        '\xff',
        '\x06',
        '\x00',
        
        '\x42',
        '\x43',
        '\x02',
        '\x00',
        '\x00',
        '\x00'}

The magic byte sequence to disambiguate bgzf compressed files.

---

The documentation for this struct was generated from the following file:

• magic_header.hpp