Search Results for

    Show / Hide Table of Contents

    Class NpgsqlReadBuffer

    A buffer used by Npgsql to read data from the socket efficiently. Provides methods which decode different values types and tracks the current position.

    Inheritance
    Object
    NpgsqlReadBuffer
    Implements
    IDisposable
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Npgsql.Internal
    Assembly: Npgsql.dll
    Syntax
    public sealed class NpgsqlReadBuffer : IDisposable

    Properties

    Connection

    Declaration
    public NpgsqlConnection Connection { get; }
    Property Value
    Type Description
    NpgsqlConnection

    Methods

    Dispose()

    Declaration
    public void Dispose()

    Ensure(Int32, Boolean)

    Declaration
    public Task Ensure(int count, bool async)
    Parameters
    Type Name Description
    Int32 count
    Boolean async
    Returns
    Type Description
    Task

    EnsureAsync(Int32)

    Declaration
    public Task EnsureAsync(int count)
    Parameters
    Type Name Description
    Int32 count
    Returns
    Type Description
    Task

    GetNullTerminatedBytes()

    Declaration
    public ReadOnlySpan<byte> GetNullTerminatedBytes()
    Returns
    Type Description
    ReadOnlySpan<Byte>

    GetStream(Int32, Boolean)

    Declaration
    public Stream GetStream(int len, bool canSeek)
    Parameters
    Type Name Description
    Int32 len
    Boolean canSeek
    Returns
    Type Description
    Stream

    Read(Span<Byte>)

    Declaration
    public int Read(Span<byte> output)
    Parameters
    Type Name Description
    Span<Byte> output
    Returns
    Type Description
    Int32

    ReadAsync(Memory<Byte>, CancellationToken)

    Declaration
    public ValueTask<int> ReadAsync(Memory<byte> output, CancellationToken cancellationToken = default(CancellationToken))
    Parameters
    Type Name Description
    Memory<Byte> output
    CancellationToken cancellationToken
    Returns
    Type Description
    ValueTask<Int32>

    ReadByte()

    Declaration
    public byte ReadByte()
    Returns
    Type Description
    Byte

    ReadBytes(Byte[], Int32, Int32)

    Declaration
    public void ReadBytes(byte[] output, int outputOffset, int len)
    Parameters
    Type Name Description
    Byte[] output
    Int32 outputOffset
    Int32 len

    ReadBytes(Span<Byte>)

    Declaration
    public void ReadBytes(Span<byte> output)
    Parameters
    Type Name Description
    Span<Byte> output

    ReadChars(Int32)

    Declaration
    public char[] ReadChars(int byteLen)
    Parameters
    Type Name Description
    Int32 byteLen
    Returns
    Type Description
    Char[]

    ReadDouble()

    Declaration
    public double ReadDouble()
    Returns
    Type Description
    Double

    ReadDouble(Boolean)

    Declaration
    public double ReadDouble(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    Double

    ReadInt16()

    Declaration
    public short ReadInt16()
    Returns
    Type Description
    Int16

    ReadInt16(Boolean)

    Declaration
    public short ReadInt16(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    Int16

    ReadInt32()

    Declaration
    public int ReadInt32()
    Returns
    Type Description
    Int32

    ReadInt32(Boolean)

    Declaration
    public int ReadInt32(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    Int32

    ReadInt64()

    Declaration
    public long ReadInt64()
    Returns
    Type Description
    Int64

    ReadInt64(Boolean)

    Declaration
    public long ReadInt64(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    Int64

    ReadMemory(Int32)

    Declaration
    public ReadOnlyMemory<byte> ReadMemory(int len)
    Parameters
    Type Name Description
    Int32 len
    Returns
    Type Description
    ReadOnlyMemory<Byte>

    ReadNullTerminatedString()

    Seeks the first null terminator (\0) and returns the string up to it. The buffer must already contain the entire string and its terminator.

    Declaration
    public string ReadNullTerminatedString()
    Returns
    Type Description
    String

    ReadNullTerminatedString(Boolean, CancellationToken)

    Declaration
    public ValueTask<string> ReadNullTerminatedString(bool async, CancellationToken cancellationToken = default(CancellationToken))
    Parameters
    Type Name Description
    Boolean async
    CancellationToken cancellationToken
    Returns
    Type Description
    ValueTask<String>

    ReadNullTerminatedStringRelaxed()

    Seeks the first null terminator (\0) and returns the string up to it. The buffer must already contain the entire string and its terminator. If any character could not be decoded, a question mark character is returned instead of throwing an exception.

    Declaration
    public string ReadNullTerminatedStringRelaxed()
    Returns
    Type Description
    String

    ReadSByte()

    Declaration
    public sbyte ReadSByte()
    Returns
    Type Description
    SByte

    ReadSingle()

    Declaration
    public float ReadSingle()
    Returns
    Type Description
    Single

    ReadSingle(Boolean)

    Declaration
    public float ReadSingle(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    Single

    ReadSpan(Int32)

    Declaration
    public ReadOnlySpan<byte> ReadSpan(int len)
    Parameters
    Type Name Description
    Int32 len
    Returns
    Type Description
    ReadOnlySpan<Byte>

    ReadString(Int32)

    Declaration
    public string ReadString(int byteLen)
    Parameters
    Type Name Description
    Int32 byteLen
    Returns
    Type Description
    String

    ReadUInt16()

    Declaration
    public ushort ReadUInt16()
    Returns
    Type Description
    UInt16

    ReadUInt16(Boolean)

    Declaration
    public ushort ReadUInt16(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    UInt16

    ReadUInt32()

    Declaration
    public uint ReadUInt32()
    Returns
    Type Description
    UInt32

    ReadUInt32(Boolean)

    Declaration
    public uint ReadUInt32(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    UInt32

    ReadUInt64()

    Declaration
    public ulong ReadUInt64()
    Returns
    Type Description
    UInt64

    ReadUInt64(Boolean)

    Declaration
    public ulong ReadUInt64(bool littleEndian)
    Parameters
    Type Name Description
    Boolean littleEndian
    Returns
    Type Description
    UInt64

    Skip(Int64, Boolean)

    Skip a given number of bytes.

    Declaration
    public async Task Skip(long len, bool async)
    Parameters
    Type Name Description
    Int64 len
    Boolean async
    Returns
    Type Description
    Task

    Implements

    System.IDisposable
    In This Article
    Back to top © Copyright 2022 The Npgsql Development Team