A writer that writes data to some sort of stream or buffer Note: the data elements written should be trivially constructible, trivially destructible, and trivially copyable. More...

#include <writer.hpp>

Collaboration diagram for mtcore::Writer< Impl >:

[legend]

Public Types
using	WriteElem = typename Impl::WriteElem

using	ErrType = typename Impl::ErrType

Public Member Functions
Result< size_t, ErrType >	write (const Slice< std::remove_const_t< WriteElem > > &s)
	Will write as much of a Slice as possible.

Result< size_t, ErrType >	write (const Slice< std::add_const_t< WriteElem > > &s)
	Will write as much of a Slice as possible.

Result< size_t, ErrType >	write (const std::remove_const_t< WriteElem > &one)
	Will write a single element If there is no room, will return the error OUT_OF_ROOM.

Result< void, ErrType >	flush ()
	Flushes a writer (i.e.

void	deinit (Allocator &allocator)
	Cleans up any memory stuff Only usable if the underlying writer has a deinit that takes an allocator.

void	deinit ()
	Cleans up writer Only usable if the underlying writer has a deinit that takes an allocator.

size_t	bytes_written () const
	Gets the number of bytes written.

Result< size_t, ErrType >	write_all (const Slice< std::remove_const_t< WriteElem > > &s)
	Will write all the elements in a Slice If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

size_t	bytes_written () const

auto	written () const

void	reset ()

Result< size_t, ErrType >	write_all (const Slice< std::add_const_t< WriteElem > > &s)
	Will write all the elements in a Slice If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Result< void, ErrType >	write_n_times (const Slice< std::remove_const_t< WriteElem > > &s, size_t n)
	Will write all the elements in a Slice N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Result< size_t, ErrType >	write_n_times (const Slice< std::add_const_t< WriteElem > > &s, size_t n)
	Will write all the elements in a Slice N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Result< size_t, ErrType >	write_n_times (const std::remove_const_t< WriteElem > &one, size_t n)
	Will write a single element N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Public Attributes
Impl	underlying

Detailed Description

template<WriterImpl Impl>
struct mtcore::Writer< Impl >

A writer that writes data to some sort of stream or buffer Note: the data elements written should be trivially constructible, trivially destructible, and trivially copyable.

Template Parameters

Impl	Writer Implementation (

See also: WriterImpl concept)

Definition at line 51 of file io/writer.hpp.

Member Typedef Documentation

◆ ErrType

template<WriterImpl Impl>

using mtcore::Writer< Impl >::ErrType = typename Impl::ErrType

Definition at line 53 of file io/writer.hpp.

◆ WriteElem

template<WriterImpl Impl>

using mtcore::Writer< Impl >::WriteElem = typename Impl::WriteElem

Definition at line 52 of file io/writer.hpp.

Member Function Documentation

◆ bytes_written() [1/2]

template<WriterImpl Impl>

size_t mtcore::Writer< Impl >::bytes_written ( ) const

inlinenodiscard

Gets the number of bytes written.

Returns: The amount of bytes written

Definition at line 118 of file io/writer.hpp.

                                               {
      return underlying.bytes_written();
    }

◆ bytes_written() [2/2]

template<WriterImpl Impl>

size_t mtcore::Writer< Impl >::bytes_written ( ) const

inlinenodiscard

Returns: Number of bytes written if able to

Definition at line 136 of file io/writer.hpp.

                                                                               {
      return underlying.bytes_written();
    }

◆ deinit() [1/2]

template<WriterImpl Impl>

void mtcore::Writer< Impl >::deinit ( )

inline

Cleans up writer Only usable if the underlying writer has a deinit that takes an allocator.

Definition at line 108 of file io/writer.hpp.

    {
      underlying.deinit();
    }

◆ deinit() [2/2]

template<WriterImpl Impl>

void mtcore::Writer< Impl >::deinit ( Allocator & allocator )

inline

Cleans up any memory stuff Only usable if the underlying writer has a deinit that takes an allocator.

Parameters

allocator Allocator for any possible memory-related cleanup

Definition at line 98 of file io/writer.hpp.

    {
      underlying.deinit(allocator);
    }

◆ flush()

template<WriterImpl Impl>

Result< void, ErrType > mtcore::Writer< Impl >::flush ( )

inline

Flushes a writer (i.e.

send any buffered output if possible)

Returns: success or error

Definition at line 86 of file io/writer.hpp.

                                  {
      if constexpr (is_flushable<Impl>) {
        return underlying.flush();
      }
      return success();
    }

Here is the call graph for this function:

◆ reset()

template<WriterImpl Impl>

void mtcore::Writer< Impl >::reset ( )

inline

Definition at line 144 of file io/writer.hpp.

                                                      {
      underlying.reset();
    }

◆ write() [1/3]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write ( const Slice< std::add_const_t< WriteElem > > & s )

inline

Will write as much of a Slice as possible.

Parameters

s	Slice to write

Returns: Number of elements written, or an error

Definition at line 69 of file io/writer.hpp.

69{ return underlying.write(s); }

◆ write() [2/3]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write ( const Slice< std::remove_const_t< WriteElem > > & s )

inline

Will write as much of a Slice as possible.

Parameters

s	Slice to write

Returns: Number of elements written, or an error

Definition at line 62 of file io/writer.hpp.

62{ return write(s.to_const()); }

mtcore::Writer::write

Result< size_t, ErrType > write(const Slice< std::remove_const_t< WriteElem > > &s)

Will write as much of a Slice as possible.

Definition io/writer.hpp:62

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [3/3]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write ( const std::remove_const_t< WriteElem > & one )

inline

Will write a single element If there is no room, will return the error OUT_OF_ROOM.

Parameters

one	Element to write

Returns: success or error

Definition at line 77 of file io/writer.hpp.

                                                                           {
      auto s = Slice<std::add_const_t<WriteElem>>{&one, 1};
      return write_all(s);
    }

Here is the call graph for this function:

◆ write_all() [1/2]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write_all ( const Slice< std::add_const_t< WriteElem > > & s )

inline

Will write all the elements in a Slice If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Parameters

s	Element to write

Returns: success or error

Definition at line 155 of file io/writer.hpp.

                                                                                 {
      auto r = underlying.write(s);
      if (r.is_error()) {
        return r.error();
      }
      // if we're dealing with a write-through writer, we have to rely on the final check in the stack
      // as there will be transformations, so we can't check for out of room here
      if constexpr (!is_write_through<Impl>) {
        if (r.value() != s.size()) {
          return error(ErrType::OUT_OF_ROOM);
        }
      }
      return success(r.value());
    }

Here is the call graph for this function:

◆ write_all() [2/2]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write_all ( const Slice< std::remove_const_t< WriteElem > > & s )

inline

Will write all the elements in a Slice If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Parameters

s	Element to write

Returns: success or error

Definition at line 129 of file io/writer.hpp.

                                                                                    {
      return write_all(s.to_const());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write_n_times() [1/3]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write_n_times	(	const Slice< std::add_const_t< WriteElem > > &	s,
		size_t	n )

inline

Will write all the elements in a Slice N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Parameters

s	Element to write
n	Number of times to write the Slice

Returns: success or error

Definition at line 190 of file io/writer.hpp.

                                                                                               {
      for (size_t i = 0; i < n; ++i) {
        auto r = write_all(s);
        if (r.is_error()) {
          return r.error();
        }
      }
      return success(n);
    }

Here is the call graph for this function:

◆ write_n_times() [2/3]

template<WriterImpl Impl>

Result< void, ErrType > mtcore::Writer< Impl >::write_n_times	(	const Slice< std::remove_const_t< WriteElem > > &	s,
		size_t	n )

inline

Will write all the elements in a Slice N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Parameters

s	Element to write
n	Number of times to write the Slice

Returns: success or error

Definition at line 178 of file io/writer.hpp.

                                                                                                {
      return write_n_times(s.to_const(), n);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write_n_times() [3/3]

template<WriterImpl Impl>

Result< size_t, ErrType > mtcore::Writer< Impl >::write_n_times	(	const std::remove_const_t< WriteElem > &	one,
		size_t	n )

inline

Will write a single element N times If there is no room, will return the error OUT_OF_ROOM Note: May Result in a partial write to the output stream.

Parameters

one	Element to write
n	Number of times to write the Slice

Returns: success or error

Definition at line 208 of file io/writer.hpp.

                                                                                             {
      auto s = Slice<std::add_const_t<WriteElem>>{&one, 1};
      for (size_t i = 0; i < n; ++i) {
        auto r = write_all(s);
        if (r.is_error()) {
          return r.error();
        }
      }
      return success(n);
    }

Here is the call graph for this function:

◆ written()

template<WriterImpl Impl>

auto mtcore::Writer< Impl >::written ( ) const

inlinenodiscard

Definition at line 140 of file io/writer.hpp.

                                                                         {
      return underlying.written();
    }

Member Data Documentation

◆ underlying

template<WriterImpl Impl>

Impl mtcore::Writer< Impl >::underlying

Definition at line 55 of file io/writer.hpp.

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

io/writer.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ErrType

◆ WriteElem

Member Function Documentation

◆ bytes_written() [1/2]

◆ bytes_written() [2/2]

◆ deinit() [1/2]

◆ deinit() [2/2]

◆ flush()

◆ reset()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ write_all() [1/2]

◆ write_all() [2/2]

◆ write_n_times() [1/3]

◆ write_n_times() [2/3]

◆ write_n_times() [3/3]

◆ written()

Member Data Documentation

◆ underlying