badgerdb::FileIterator Class Reference

Iterator for iterating over the pages in a file. More...

#include <file_iterator.h>

List of all members.

Public Member Functions
	FileIterator ()
	FileIterator (File *file)
	FileIterator (File *file, PageId page_number)
FileIterator &	operator++ ()
FileIterator	operator++ (int)
bool	operator== (const FileIterator &rhs) const
bool	operator!= (const FileIterator &rhs) const
Page	operator* () const

---

Detailed Description

Iterator for iterating over the pages in a file.

This class provides a forward-only iterator for iterating over all of the pages in a file.

Definition at line 23 of file file_iterator.h.

---

Constructor & Destructor Documentation

badgerdb::FileIterator::FileIterator

(

)

[inline]

Constructs an empty iterator.

Definition at line 28 of file file_iterator.h.

      : file_(NULL),
        current_page_number_(Page::INVALID_NUMBER) {
  }

badgerdb::FileIterator::FileIterator

(

File *

file

)

[inline]

Constructors an iterator over the pages in a file, starting at the first page.

Parameters:

file	File to iterate over.

Definition at line 39 of file file_iterator.h.

      : file_(file) {
    assert(file_ != NULL);
    const FileHeader& header = file_->readHeader();
    current_page_number_ = header.first_used_page;
  }

badgerdb::FileIterator::FileIterator	(	File *	file,
		PageId	page_number
	)		[inline]

Constructs an iterator over the pages in a file, starting at the given page number.

Parameters:

file	File to iterate over.
page_number	Number of page to start iterator at.

Definition at line 53 of file file_iterator.h.

      : file_(file),
        current_page_number_(page_number) {
  }

---

Member Function Documentation

Page badgerdb::FileIterator::operator*

(

)

const [inline]

Dereferences the iterator, returning a copy of the current page in the file.

Returns:

Page in file.

Definition at line 103 of file file_iterator.h.

  { return file_->readPage(current_page_number_); }

FileIterator& badgerdb::FileIterator::operator++

(

)

[inline]

Advances the iterator to the next page in the file.

Definition at line 61 of file file_iterator.h.

                                    {
    assert(file_ != NULL);
    const PageHeader& header = file_->readPageHeader(current_page_number_);
    current_page_number_ = header.next_page_number;

    return *this;
  }

bool badgerdb::FileIterator::operator==

(

const FileIterator &

rhs

)

const [inline]

Returns true if this iterator is equal to the given iterator.

Parameters:

rhs	Iterator to compare against.

Returns:

True if other iterator is equal to this one.

Definition at line 87 of file file_iterator.h.

                                                        {
    return file_->filename() == rhs.file_->filename() &&
        current_page_number_ == rhs.current_page_number_;
  }

---

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

• /afs/cs.wisc.edu/p/course/cs564-jignesh/public/html/projects/BadgerDB/bufmgr/src/file_iterator.h