system.io.pipelines

Class PipeReader

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.io.pipelines.PipeReader

All Implemented Interfaces:

IJCOBridgeReflected

public class PipeReader
extends NetObject

The base .NET class managing System.IO.Pipelines.PipeReader, System.IO.Pipelines, Version=9.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.IO.Pipelines.PipeReader

Powered by JCOBridge: more info at https://www.jcobridge.com

Author:

MASES s.r.l https://masesgroup.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assemblyFullName Fully assembly qualified name: System.IO.Pipelines, Version=9.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
static java.lang.String	assemblyShortName Assembly name: System.IO.Pipelines
static java.lang.String	className Qualified class name: System.IO.Pipelines.PipeReader
static JCType	classType The type managed from JCOBridge.

Fields inherited from class org.mases.jcobridge.netreflection.NetObject

Null

Constructor Summary

Constructors

Constructor and Description
PipeReader()
PipeReader(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
void	AdvanceTo(SequencePosition consumed) Invokes the .NET member AdvanceTo.
void	AdvanceTo(SequencePosition consumed, SequencePosition examined) Invokes the .NET member AdvanceTo.
Stream	AsStream(boolean leaveOpen) Invokes the .NET member AsStream.
void	CancelPendingRead() Invokes the .NET member CancelPendingRead.
static PipeReader	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into PipeReader, a cast assert is made to check if types are compatible.
void	Complete(NetException exception) Invokes the .NET member Complete.
ValueTask	CompleteAsync(NetException exception) Invokes the .NET member CompleteAsync.
Task	CopyToAsync(PipeWriter destination, CancellationToken cancellationToken) Invokes the .NET member CopyToAsync.
Task	CopyToAsync(Stream destination, CancellationToken cancellationToken) Invokes the .NET member CopyToAsync.
static PipeReader	Create(ReadOnlySequence_1 sequence) Invokes the .NET member Create.
static PipeReader	Create(Stream stream, StreamPipeReaderOptions readerOptions) Invokes the .NET member Create.
java.lang.String	getJCOAssemblyName() Returns the full name of the assembly of the .NET type.
java.lang.String	getJCOClassName() Returns the full name of the .NET type.
java.lang.Object	getJCOInstance() Returns the underlying object managed by the bridge.
java.lang.String	getJCOObjectName() Returns the name of the .NET type qualified with its assembly.
JCType	getJCOType() Returns the JCType of the .NET type.
void	OnWriterCompleted(Action_2 callback, NetObject state) Invokes the .NET member OnWriterCompleted.
ValueTask_1	ReadAsync(CancellationToken cancellationToken) Invokes the .NET member ReadAsync.
ValueTask_1	ReadAtLeastAsync(int minimumSize, CancellationToken cancellationToken) Invokes the .NET member ReadAtLeastAsync.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.
boolean	TryRead(JCORefOut<ReadResult> result) Invokes the .NET member TryRead.

Methods inherited from class org.mases.jcobridge.netreflection.NetObject

Equals, Equals, GetHashCode, GetType, hashCode, toString, ToString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

assemblyFullName

public static final java.lang.String assemblyFullName

Fully assembly qualified name: System.IO.Pipelines, Version=9.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.IO.Pipelines

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.IO.Pipelines.PipeReader

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

PipeReader

public PipeReader()
           throws java.lang.Throwable

Throws:

java.lang.Throwable

PipeReader

public PipeReader(java.lang.Object instance)
           throws java.lang.Throwable

Internal constructor. Use with caution

Parameters:

instance - the underlying bridge object: it must be a JCObject

Throws:

java.lang.Throwable - if instance is not a JCObject

Method Detail

AdvanceTo

public void AdvanceTo(SequencePosition consumed)
               throws java.lang.Throwable

Invokes the .NET member AdvanceTo.

Parameters:

consumed - the argument of type SequencePosition

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

AdvanceTo

public void AdvanceTo(SequencePosition consumed,
                      SequencePosition examined)
               throws java.lang.Throwable

Invokes the .NET member AdvanceTo.

Parameters:

consumed - the argument of type SequencePosition

examined - the argument of type SequencePosition

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

AsStream

public Stream AsStream(boolean leaveOpen)
                throws java.lang.Throwable

Invokes the .NET member AsStream.

Parameters:

leaveOpen - the argument of type boolean

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

CancelPendingRead

public void CancelPendingRead()
                       throws java.lang.Throwable

Invokes the .NET member CancelPendingRead.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

cast

public static PipeReader cast(IJCOBridgeReflected from)
                       throws java.lang.Throwable

Try to cast the IJCOBridgeReflected instance into PipeReader, a cast assert is made to check if types are compatible.

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

PipeReader instance

Throws:

java.lang.Throwable - in case of error during cast operation

Complete

public void Complete(NetException exception)
              throws java.lang.Throwable

Invokes the .NET member Complete.

Parameters:

exception - the argument of type NetException

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

CompleteAsync

public ValueTask CompleteAsync(NetException exception)
                        throws java.lang.Throwable,
                               ArgumentException,
                               ArgumentOutOfRangeException,
                               PlatformNotSupportedException,
                               NotSupportedException,
                               ObjectDisposedException,
                               InvalidOperationException,
                               RankException,
                               ArrayTypeMismatchException,
                               ArgumentNullException,
                               NullReferenceException,
                               IndexOutOfRangeException

Invokes the .NET member CompleteAsync.

Parameters:

exception - the argument of type NetException

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

NullReferenceException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

See Also:

.NET documentation

CopyToAsync

public Task CopyToAsync(PipeWriter destination,
                        CancellationToken cancellationToken)
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        PlatformNotSupportedException,
                        NotSupportedException,
                        ObjectDisposedException,
                        InvalidOperationException,
                        RankException,
                        ArrayTypeMismatchException,
                        ArgumentNullException

Invokes the .NET member CopyToAsync.

Parameters:

destination - the argument of type PipeWriter

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

CopyToAsync

public Task CopyToAsync(Stream destination,
                        CancellationToken cancellationToken)
                 throws java.lang.Throwable,
                        ArgumentException,
                        ArgumentOutOfRangeException,
                        PlatformNotSupportedException,
                        NotSupportedException,
                        ObjectDisposedException,
                        InvalidOperationException,
                        RankException,
                        ArrayTypeMismatchException,
                        ArgumentNullException,
                        NullReferenceException,
                        OperationCanceledException,
                        SemaphoreFullException,
                        TaskSchedulerException

Invokes the .NET member CopyToAsync.

Parameters:

destination - the argument of type Stream

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

NullReferenceException - if the .NET member raises it

OperationCanceledException - if the .NET member raises it

SemaphoreFullException - if the .NET member raises it

TaskSchedulerException - if the .NET member raises it

See Also:

.NET documentation

Create

public static PipeReader Create(ReadOnlySequence_1 sequence)
                         throws java.lang.Throwable

Invokes the .NET member Create.

Parameters:

sequence - the argument of type ReadOnlySequence_1

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

Create

public static PipeReader Create(Stream stream,
                                StreamPipeReaderOptions readerOptions)
                         throws java.lang.Throwable,
                                ArgumentException,
                                NotSupportedException,
                                InvalidOperationException,
                                ArgumentOutOfRangeException,
                                ArgumentNullException

Invokes the .NET member Create.

Parameters:

stream - the argument of type Stream

readerOptions - the argument of type StreamPipeReaderOptions

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

ArgumentNullException - if the .NET member raises it

See Also:

.NET documentation

getJCOAssemblyName

public java.lang.String getJCOAssemblyName()

Description copied from class: NetObject

Returns the full name of the assembly of the .NET type.

Specified by:

getJCOAssemblyName in interface IJCOBridgeReflected

Overrides:

getJCOAssemblyName in class NetObject

Returns:

the full assembly name

getJCOClassName

public java.lang.String getJCOClassName()

Description copied from class: NetObject

Returns the full name of the .NET type.

Specified by:

getJCOClassName in interface IJCOBridgeReflected

Overrides:

getJCOClassName in class NetObject

Returns:

the full class name

getJCOInstance

public java.lang.Object getJCOInstance()

Description copied from class: NetObject

Returns the underlying object managed by the bridge.

Specified by:

getJCOInstance in interface IJCOBridgeReflected

Overrides:

getJCOInstance in class NetObject

Returns:

the underlying object, or null if there is none

getJCOObjectName

public java.lang.String getJCOObjectName()

Description copied from class: NetObject

Returns the name of the .NET type qualified with its assembly.

Specified by:

getJCOObjectName in interface IJCOBridgeReflected

Overrides:

getJCOObjectName in class NetObject

Returns:

the assembly qualified name

getJCOType

public JCType getJCOType()

Description copied from class: NetObject

Returns the JCType of the .NET type.

Specified by:

getJCOType in interface IJCOBridgeReflected

Overrides:

getJCOType in class NetObject

Returns:

the type of the .NET class

OnWriterCompleted

public void OnWriterCompleted(Action_2 callback,
                              NetObject state)
                       throws java.lang.Throwable

Invokes the .NET member OnWriterCompleted.

Parameters:

callback - the argument of type Action_2

state - the argument of type NetObject

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

ReadAsync

public ValueTask_1 ReadAsync(CancellationToken cancellationToken)
                      throws java.lang.Throwable

Invokes the .NET member ReadAsync.

Parameters:

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

ReadAtLeastAsync

public ValueTask_1 ReadAtLeastAsync(int minimumSize,
                                    CancellationToken cancellationToken)
                             throws java.lang.Throwable,
                                    ArgumentException,
                                    ArgumentOutOfRangeException,
                                    PlatformNotSupportedException,
                                    NotSupportedException,
                                    ObjectDisposedException,
                                    InvalidOperationException,
                                    RankException,
                                    ArrayTypeMismatchException

Invokes the .NET member ReadAtLeastAsync.

Parameters:

minimumSize - the argument of type int

cancellationToken - the argument of type CancellationToken

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

RankException - if the .NET member raises it

ArrayTypeMismatchException - if the .NET member raises it

See Also:

.NET documentation

setJCOInstance

public void setJCOInstance(JCObject instance)

Description copied from class: NetObject

Sets the underlying object managed by the bridge.

Overrides:

setJCOInstance in class NetObject

Parameters:

instance - the new underlying object

TryRead

public boolean TryRead(JCORefOut<ReadResult> result)
                throws java.lang.Throwable

Invokes the .NET member TryRead.

Parameters:

result - the argument of type JCORefOut<ReadResult>

Returns:

the value returned by the .NET member

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation