Class ArmoredInputStream

Namespace

Org.BouncyCastle.Bcpg

Assembly

BouncyCastle.Cryptography.dll

public class ArmoredInputStream : BaseInputStream, IAsyncDisposable, IDisposable

Inheritance

object

MarshalByRefObject

Stream

BaseInputStream

ArmoredInputStream

Implements

IAsyncDisposable

IDisposable

Inherited Members

BaseInputStream.CanRead

BaseInputStream.CanSeek

BaseInputStream.CanWrite

BaseInputStream.CopyTo(Stream, int)

BaseInputStream.CopyToAsync(Stream, int, CancellationToken)

BaseInputStream.Flush()

BaseInputStream.Length

BaseInputStream.Position

BaseInputStream.ReadAsync(Memory<byte>, CancellationToken)

BaseInputStream.Seek(long, SeekOrigin)

BaseInputStream.SetLength(long)

BaseInputStream.Write(byte[], int, int)

BaseInputStream.Write(ReadOnlySpan<byte>)

BaseInputStream.WriteAsync(ReadOnlyMemory<byte>, CancellationToken)

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.Close()

Stream.CopyTo(Stream)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CreateWaitHandle()

Stream.Dispose()

Stream.DisposeAsync()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.FlushAsync(CancellationToken)

Stream.ObjectInvariant()

Stream.ReadAsync(byte[], int, int)

Stream.ReadAsync(byte[], int, int, CancellationToken)

Stream.Synchronized(Stream)

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.WriteAsync(byte[], int, int)

Stream.WriteAsync(byte[], int, int, CancellationToken)

Stream.WriteByte(byte)

Stream.CanTimeout

Stream.ReadTimeout

Stream.WriteTimeout

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArmoredInputStream(Stream)

public ArmoredInputStream(Stream input)

Parameters

input Stream

ArmoredInputStream(Stream, bool)

public ArmoredInputStream(Stream input, bool hasHeaders)

Parameters

input Stream

hasHeaders bool

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.

GetArmorHeaderLine()

public string GetArmorHeaderLine()

Returns

string

GetArmorHeaders()

public string[] GetArmorHeaders()

Returns

string[]

IsClearText()

public bool IsClearText()

Returns

bool

IsEndOfStream()

public bool IsEndOfStream()

Returns

bool

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.

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.

SetDetectMissingCrc(bool)

public virtual void SetDetectMissingCrc(bool detectMissing)

Parameters

detectMissing bool