Interface IInputBytes

Namespace

UglyToad.PdfPig.Core

Assembly

UglyToad.PdfPig.Core.dll

The input bytes for a PDF document.

public interface IInputBytes : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

CurrentByte

The current byte.

byte CurrentByte { get; }

Property Value

byte

CurrentOffset

The current offset in bytes.

long CurrentOffset { get; }

Property Value

long

Length

The length of the data in bytes.

long Length { get; }

Property Value

long

Methods

IsAtEnd()

Whether we are at the end of the available data.

bool IsAtEnd()

Returns

bool

MoveNext()

Moves to the next byte if available.

bool MoveNext()

Returns

bool

Peek()

Returns the next byte if available.

byte? Peek()

Returns

byte?

Read(byte[], int?)

Fill the buffer with bytes starting from the current position.

int Read(byte[] buffer, int? length = null)

Parameters

buffer byte[]

A buffer with a length corresponding to the number of bytes to read.

length int?

Optional override for the number of bytes to read.

Returns

int

The number of bytes successfully read.

Seek(long)

Move to a given position.

void Seek(long position)

Parameters

position long