Method iter_objects

src/borg/legacyrepository.py:1479–1510

Return object iterator for *segment*. See the _read() docstring about confidence in the returned data. The iterator returns five-tuples of (tag, key, offset, size, data).

(self, segment, read_data=True)

        return fd.read(MAGIC_LEN)

    def iter_objects(self, segment, read_data=True):
        """
        Return object iterator for *segment*.

        See the _read() docstring about confidence in the returned data.

        The iterator returns five-tuples of (tag, key, offset, size, data).
        """
        fd = self.get_fd(segment)
        offset = 0
        fd.seek(offset)
        if fd.read(MAGIC_LEN) != MAGIC:
            raise IntegrityError(f"Invalid segment magic [segment {segment}, offset {offset}]")
        offset = MAGIC_LEN
        header = fd.read(self.header_fmt.size)
        while header:
            size, tag, key, data = self._read(
                fd, header, segment, offset, (TAG_PUT2, TAG_DELETE, TAG_COMMIT, TAG_PUT), read_data=read_data
            )
            # tuple[3]: corresponds to len(data) == length of the full chunk payload (meta_len+enc_meta+enc_data)
            # tuple[4]: data will be None if read_data is False.
            yield tag, key, offset, size - header_size(tag), data
            assert size >= 0
            offset += size
            # we must get the fd via get_fd() here again as we yielded to our caller and it might
            # have triggered closing of the fd we had before (e.g. by calling io.read() for
            # different segment(s)).
            # by calling get_fd() here again we also make our fd "recently used" so it likely
            # does not get kicked out of self.fds LRUcache.
            fd = self.get_fd(segment)
            fd.seek(offset)
            header = fd.read(self.header_fmt.size)

    def recover_segment(self, segment, filename):
        logger.info("Attempting to recover " + filename)