cusbf::detail::FastxFileBuffer Class Reference

Read-only contiguous file payload for in-memory FASTX parsing. More...

#include <fastx_file_buffer.hpp>

Public Member Functions
	FastxFileBuffer ()=default
	FastxFileBuffer (const FastxFileBuffer &)=delete
FastxFileBuffer &	operator= (const FastxFileBuffer &)=delete
	FastxFileBuffer (FastxFileBuffer &&other) noexcept
FastxFileBuffer &	operator= (FastxFileBuffer &&other) noexcept
	~FastxFileBuffer ()
std::string_view	data () const noexcept
	Contiguous read-only file bytes.
bool	empty () const noexcept
	True when the file is empty or load produced no bytes.

Static Public Member Functions
static Result< std::unique_ptr< FastxFileBuffer > >	load (const std::filesystem::path &path)
	Loads an uncompressed file via mmap (Linux) or read into memory.

Detailed Description

Read-only contiguous file payload for in-memory FASTX parsing.

Definition at line 26 of file fastx_file_buffer.hpp.

Constructor & Destructor Documentation

FastxFileBuffer() [1/3]

cusbf::detail::FastxFileBuffer::FastxFileBuffer ( )

default

FastxFileBuffer() [2/3]

cusbf::detail::FastxFileBuffer::FastxFileBuffer ( const FastxFileBuffer &  )

delete

FastxFileBuffer() [3/3]

cusbf::detail::FastxFileBuffer::FastxFileBuffer ( FastxFileBuffer &&  other )

inlinenoexcept

Definition at line 31 of file fastx_file_buffer.hpp.

                                                      {
        *this = std::move(other);
    }

Here is the call graph for this function:

~FastxFileBuffer()

cusbf::detail::FastxFileBuffer::~FastxFileBuffer ( )

inline

Definition at line 53 of file fastx_file_buffer.hpp.

                       {
        release();
    }

Member Function Documentation

data()

std::string_view cusbf::detail::FastxFileBuffer::data ( ) const

inlinenoexcept

Contiguous read-only file bytes.

Definition at line 72 of file fastx_file_buffer.hpp.

                                                       {
        return std::string_view{data_, size_};
    }

empty()

bool cusbf::detail::FastxFileBuffer::empty ( ) const

inlinenoexcept

True when the file is empty or load produced no bytes.

Definition at line 77 of file fastx_file_buffer.hpp.

                                              {
        return size_ == 0;
    }

load()

static Result< std::unique_ptr< FastxFileBuffer > > cusbf::detail::FastxFileBuffer::load ( const std::filesystem::path &  path )

inlinestatic

Loads an uncompressed file via mmap (Linux) or read into memory.

Parameters

path	Path to a non-gzip FASTA/FASTQ file.

Returns

Owning buffer with data() spanning the full file.

Definition at line 63 of file fastx_file_buffer.hpp.

      {
        auto buffer = std::make_unique<FastxFileBuffer>();
        CUSBF_TRY(buffer->load_from_path(path));
        return buffer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

FastxFileBuffer & cusbf::detail::FastxFileBuffer::operator= ( const FastxFileBuffer &  )

delete

operator=() [2/2]

FastxFileBuffer & cusbf::detail::FastxFileBuffer::operator= ( FastxFileBuffer &&  other )

inlinenoexcept

Definition at line 35 of file fastx_file_buffer.hpp.

                                                                 {
        if (this != &other) {
            release();
            owned_storage_ = std::move(other.owned_storage_);
            data_ = other.data_;
            size_ = other.size_;
#if defined(__linux__)
            mapped_ = other.mapped_;
            mapped_size_ = other.mapped_size_;
            other.mapped_ = nullptr;
            other.mapped_size_ = 0;
#endif
            other.data_ = nullptr;
            other.size_ = 0;
        }
        return *this;
    }

Here is the call graph for this function:

---

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

• fastx_file_buffer.hpp