Table of Contents

Class BcpgInputStream

Namespace
Org.BouncyCastle.Bcpg
Assembly
BouncyCastle.Cryptography.dll
public class BcpgInputStream : BaseInputStream, IAsyncDisposable, IDisposable
Inheritance
BcpgInputStream
Implements
Inherited Members

Remarks

Reader for PGP objects.

Methods

Dispose(bool)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

NextPacketTag()

Returns the next packet tag in the stream.

public PacketTag NextPacketTag()

Returns

PacketTag

Read(byte[], int, int)

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public override int Read(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

Returns

int

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Exceptions

ArgumentException

The sum of offset and count is larger than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurs.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Read(Span<byte>)

When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

public override int Read(Span<byte> buffer)

Parameters

buffer Span<byte>

A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

int

The total number of bytes read into the buffer. This can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

ReadAll()

public byte[] ReadAll()

Returns

byte[]

ReadByte()

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

public override int ReadByte()

Returns

int

The unsigned byte cast to an int, or -1 if at the end of the stream.

Exceptions

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

ReadFully(byte[])

public void ReadFully(byte[] buffer)

Parameters

buffer byte[]

ReadFully(byte[], int, int)

public void ReadFully(byte[] buffer, int offset, int count)

Parameters

buffer byte[]
offset int
count int

ReadFully(Span<byte>)

public void ReadFully(Span<byte> buffer)

Parameters

buffer Span<byte>

ReadPacket()

public Packet ReadPacket()

Returns

Packet

RequireByte()

public byte RequireByte()

Returns

byte

SkipMarkerPackets()

public PacketTag SkipMarkerPackets()

Returns

PacketTag