ar-cpp
Public Types | Public Member Functions | List of all members
ar::Files Class Reference

A vector-like container storing files. More...

#include <file.h>

Public Types

using size_type = Container::size_type
 
using value_type = Container::value_type
 
using reference = Container::reference
 
using iterator = Container::iterator
 

Public Member Functions

 Files ()
 Constructs an empty container (without files). More...
 
 Files (Files &&other)
 
 ~Files ()
 
File Access
reference front ()
 Returns a reference to the first file in the container. More...
 
reference back ()
 Returns a reference to the last file in the container. More...
 
Iterators
iterator begin () noexcept
 
iterator end () noexcept
 
Capacity
bool empty () const noexcept
 Is the container empty? More...
 
size_type size () const noexcept
 Returns the number of files in the container. More...
 
Modifiers
void push_back (value_type file)
 Appends the given file to the end of the container. More...
 

Detailed Description

A vector-like container storing files.

Member Typedef Documentation

◆ iterator

using ar::Files::iterator = Container::iterator

◆ reference

using ar::Files::reference = Container::reference

◆ size_type

using ar::Files::size_type = Container::size_type

◆ value_type

using ar::Files::value_type = Container::value_type

Constructor & Destructor Documentation

◆ Files() [1/2]

ar::Files::Files ( )
default

Constructs an empty container (without files).

◆ Files() [2/2]

ar::Files::Files ( Files &&  other)

◆ ~Files()

ar::Files::~Files ( )
default

Member Function Documentation

◆ back()

auto ar::Files::back ( )

Returns a reference to the last file in the container.

Calling this function on an empty container is undefined.

◆ begin()

auto ar::Files::begin ( )
noexcept

◆ empty()

bool ar::Files::empty ( ) const
noexcept

Is the container empty?

◆ end()

auto ar::Files::end ( )
noexcept

◆ front()

auto ar::Files::front ( )

Returns a reference to the first file in the container.

Calling this function on an empty container is undefined.

◆ push_back()

void ar::Files::push_back ( value_type  file)

Appends the given file to the end of the container.

◆ size()

auto ar::Files::size ( ) const
noexcept

Returns the number of files in the container.


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