Lines Matching +full:block +full:- +full:offset
1 /* SPDX-License-Identifier: 0BSD */
27 * a time. All functions that take non-const pointer to lzma_index
70 * If this is zero, the block structure below has
76 * \brief Compressed start offset of this Stream
78 * The offset is relative to the beginning of the lzma_index
84 * \brief Uncompressed start offset of this Stream
86 * The offset is relative to the beginning of the lzma_index
129 * \brief Block number in the file
131 * The first Block is 1.
136 * \brief Compressed start offset of this Block
138 * This offset is relative to the beginning of the
141 * to start decompressing this Block.
146 * \brief Uncompressed start offset of this Block
148 * This offset is relative to the beginning of the lzma_index
151 * When doing random-access reading, it is possible that
152 * the target offset is not exactly at Block boundary. One
153 * will need to compare the target offset against
156 * before reaching the target offset.
161 * \brief Block number in this Stream
163 * The first Block is 1.
168 * \brief Compressed start offset of this Block
170 * This offset is relative to the beginning of the Stream
171 * containing this Block.
176 * \brief Uncompressed start offset of this Block
178 * This offset is relative to the beginning of the Stream
179 * containing this Block.
184 * \brief Uncompressed size of this Block
186 * You should pass this to the Block decoder if you will
187 * decode this Block. It will allow the Block decoder to
193 * \brief Unpadded size of this Block
195 * You should pass this to the Block decoder if you will
196 * decode this Block. It will allow the Block decoder to
204 * This includes all headers and padding in this Block.
206 * the Block decoder will actually read.
233 } block; member
261 * \brief Get the next Block or Stream
263 * Go to the next Block if the current Stream has at least
264 * one Block left. Otherwise go to the next Stream even if
267 * lzma_index_iter.block will have undefined values.
276 * Block, the iterator will point to the first Block.
277 * If there are no Blocks, lzma_index_iter.block will have
283 * \brief Get the next Block
285 * Go to the next Block if the current Stream has at least
286 * one Block left. If the current Stream has no Blocks left,
287 * the next Stream with at least one Block is located and
288 * the iterator will be made to point to the first Block of
294 * \brief Get the next non-empty Block
329 * stored and the size of the Records (due to variable-length integer
390 * \brief Add a new Block to lzma_index
396 * \param unpadded_size Unpadded Size of a Block. This can be
398 * after encoding or decoding the Block.
399 * \param uncompressed_size Uncompressed Size of a Block. This can be
401 * after encoding or decoding the Block.
403 * Appending a new Block does not invalidate iterators. For example,
405 * lzma_index_append() it is possible to read the next Block with
409 * - LZMA_OK
410 * - LZMA_MEM_ERROR
411 * - LZMA_DATA_ERROR: Compressed or uncompressed size of the
413 * - LZMA_PROG_ERROR
437 * - LZMA_OK
438 * - LZMA_OPTIONS_ERROR: Unsupported stream_flags->version.
439 * - LZMA_PROG_ERROR
454 * The bitmask is 1 << check_id, e.g. CRC32 is 1 << 1 and SHA-256 is 1 << 10.
469 * Stream in the lzma_index. This is needed when planning to do random-access
475 * - LZMA_OK
476 * - LZMA_DATA_ERROR: The file size would grow too big.
477 * - LZMA_PROG_ERROR
606 * return the first Block or Stream.
615 * \brief Get the next Block or Stream
622 * - true if no Block or Stream matching the mode is found.
624 * - false if the next Block or Stream matching the mode was
633 * \brief Locate a Block
636 * the Index field(s) and use lzma_index_iter_locate() to do random-access
637 * reading with granularity of Block size.
641 * - Information about the Stream and Block containing the requested
642 * uncompressed offset is stored into *iter.
643 * - Internal state of the iterator is adjusted so that
651 * \param target Uncompressed target offset which the caller would
655 * - true if the target is greater than or equal to the
657 * - false if the target is smaller than the uncompressed size
667 * Concatenating lzma_indexes is useful when doing random-access reading in
668 * multi-Stream .xz file, or when combining multiple Streams into single
680 * - LZMA_OK: lzma_indexes were concatenated successfully.
682 * - LZMA_DATA_ERROR: *dest would grow too big.
683 * - LZMA_MEM_ERROR
684 * - LZMA_PROG_ERROR
715 * - LZMA_OK: Initialization succeeded, continue with lzma_code().
716 * - LZMA_MEM_ERROR
717 * - LZMA_PROG_ERROR
745 * - LZMA_OK: Initialization succeeded, continue with lzma_code().
746 * - LZMA_MEM_ERROR
747 * - LZMA_PROG_ERROR
759 * \brief Single-call .xz Index encoder
772 * - LZMA_OK: Encoding was successful.
773 * - LZMA_BUF_ERROR: Output buffer is too small. Use
776 * - LZMA_PROG_ERROR
784 * \brief Single-call .xz Index decoder
805 * - LZMA_OK: Decoding was successful.
806 * - LZMA_MEM_ERROR
807 * - LZMA_MEMLIMIT_ERROR: Memory usage limit was reached.
809 * - LZMA_DATA_ERROR
810 * - LZMA_PROG_ERROR
851 * - LZMA_OK: All OK so far, more input needed
852 * - LZMA_SEEK_NEEDED: Provide more input starting from the absolute
853 * file position strm->seek_pos
854 * - LZMA_STREAM_END: Decoding was successful, *dest_index has been set
855 * - LZMA_FORMAT_ERROR: The input file is not in the .xz format (the
857 * - LZMA_OPTIONS_ERROR: File looks valid but contains headers that aren't
859 * - LZMA_DATA_ERROR: File is corrupt
860 * - LZMA_BUF_ERROR
861 * - LZMA_MEM_ERROR
862 * - LZMA_MEMLIMIT_ERROR
863 * - LZMA_PROG_ERROR
875 * - LZMA_OK
876 * - LZMA_MEM_ERROR
877 * - LZMA_PROG_ERROR