Table of Contents

Class PdfRangedOptions

Namespace
PdfEngine.Vector.Parsing
Assembly
PdfEngine.Vector.dll

Settings of a PdfRangedDocument.

public sealed class PdfRangedOptions
Inheritance
PdfRangedOptions
Inherited Members

Properties

BlockSize

The block size of the cache (default 4 KB).

public int BlockSize { get; init; }

Property Value

int

CacheBytes

The most fetched bytes kept in memory (default 64 MB). A page's own bytes are kept while it is parsed, whatever the cap.

public long CacheBytes { get; init; }

Property Value

long

CompletionRequestBytes

The size of each read of ReadAllAsync(IProgress<long>?, CancellationToken) (default 1 MB).

public int CompletionRequestBytes { get; init; }

Property Value

int

InitialData

Bytes the host already has (for example the start of the file, or its end), as (offset, bytes) pairs.

public IReadOnlyList<(long Offset, ReadOnlyMemory<byte> Data)> InitialData { get; init; }

Property Value

IReadOnlyList<(long Offset, ReadOnlyMemory<byte> Data)>

LazyPageTree

Find each page in the page tree when it is first needed (default true): opening reads the catalog and the root of the page tree only, and a page needs only the tree nodes on its path. False reads every page's dictionary while the document opens. A tree whose /Count values do not match its kids is read whole either way (PageTreeFallbackReason).

public bool LazyPageTree { get; init; }

Property Value

bool

MaxConcurrentRequests

The most reads at the same time (default 4).

public int MaxConcurrentRequests { get; init; }

Property Value

int

MaxRequestBytes

The most bytes in one read (default 4 MB).

public int MaxRequestBytes { get; init; }

Property Value

int

MaxRoundBytes

The most bytes fetched in one round after a miss, and for the document's structure when it opens (default 32 MB). Past it, the file is read whole. The cache holds at most CacheBytes plus this while a document opens.

public long MaxRoundBytes { get; init; }

Property Value

long

MaxRounds

How many times an operation is tried again after fetching what it missed, before the whole file is downloaded (default 12).

public int MaxRounds { get; init; }

Property Value

int

MaxWalkBytes

The most bytes that the objects of one walk (the document's structure, or one page) may need (default 256 MB). A walk that would ask for more stops, and the file is read whole (FallbackReason says so).

public long MaxWalkBytes { get; init; }

Property Value

long

MergeGapBytes

Reads closer than this are joined into one (default 16 KB).

public long MergeGapBytes { get; init; }

Property Value

long

ReadAheadBytes

A miss is fetched with at least this many bytes around it (default 64 KB).

public int ReadAheadBytes { get; init; }

Property Value

int

TailBytes

The end of the file fetched first, for the cross-reference data and the trailer (default 1 MB).

public int TailBytes { get; init; }

Property Value

int