cusbf::detail::GzStreambuf Class Reference

std::streambuf over a gzip file (zlib gzread). More...

#include <gzstreambuf.hpp>

Inheritance diagram for cusbf::detail::GzStreambuf:

Collaboration diagram for cusbf::detail::GzStreambuf:

Public Member Functions
	GzStreambuf (const GzStreambuf &)=delete
GzStreambuf &	operator= (const GzStreambuf &)=delete
	GzStreambuf (GzStreambuf &&)=delete
GzStreambuf &	operator= (GzStreambuf &&)=delete
	~GzStreambuf () override

Static Public Member Functions
static Result< std::unique_ptr< GzStreambuf > >	open (const std::filesystem::path &path)
	Opens path for binary gzip read.

Protected Member Functions
int_type	underflow () override

Detailed Description

std::streambuf over a gzip file (zlib gzread).

Definition at line 18 of file gzstreambuf.hpp.

Constructor & Destructor Documentation

GzStreambuf() [1/2]

cusbf::detail::GzStreambuf::GzStreambuf ( const GzStreambuf &  )

delete

GzStreambuf() [2/2]

cusbf::detail::GzStreambuf::GzStreambuf ( GzStreambuf &&  )

delete

~GzStreambuf()

cusbf::detail::GzStreambuf::~GzStreambuf ( )

inlineoverride

Definition at line 40 of file gzstreambuf.hpp.

                            {
        if (file_) {
            gzclose(file_);
        }
    }

Here is the call graph for this function:

Member Function Documentation

open()

static Result< std::unique_ptr< GzStreambuf > > cusbf::detail::GzStreambuf::open ( const std::filesystem::path &  path )

inlinestatic

Opens path for binary gzip read.

Parameters

path	Filesystem path to a .gz file.

Definition at line 30 of file gzstreambuf.hpp.

      {
        auto streambuf = std::unique_ptr<GzStreambuf>(new GzStreambuf(path));
        if (!streambuf->file_) {
            return Err(Error::io(std::format("Failed to open gzip file: {}", path.string())));
        }
        return streambuf;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

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

delete

operator=() [2/2]

GzStreambuf & cusbf::detail::GzStreambuf::operator= ( GzStreambuf &&  )

delete

underflow()

int_type cusbf::detail::GzStreambuf::underflow ( )

inlineoverrideprotected

Definition at line 47 of file gzstreambuf.hpp.

                                  {
        if (gptr() < egptr()) {
            return traits_type::to_int_type(*gptr());
        }
 
        auto bytesRead = gzread(file_, buffer_, kBufferSize);
        if (bytesRead <= 0) {
            return traits_type::eof();
        }
 
        setg(buffer_, buffer_, buffer_ + bytesRead);
        return traits_type::to_int_type(*gptr());
    }

Here is the call graph for this function:

---

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

• gzstreambuf.hpp