Search Results for

    Show / Hide Table of Contents

    Class BoxHandler

    A type handler for the PostgreSQL box data type.

    Inheritance
    Object
    NpgsqlTypeHandler
    NpgsqlTypeHandler<NpgsqlBox>
    NpgsqlSimpleTypeHandler<NpgsqlBox>
    BoxHandler
    Implements
    INpgsqlTypeHandler<NpgsqlBox>
    INpgsqlSimpleTypeHandler<NpgsqlBox>
    Inherited Members
    NpgsqlSimpleTypeHandler<NpgsqlBox>.Read(NpgsqlReadBuffer, Int32, Boolean, FieldDescription)
    NpgsqlSimpleTypeHandler<NpgsqlBox>.Write(NpgsqlBox, NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, Boolean, CancellationToken)
    NpgsqlSimpleTypeHandler<NpgsqlBox>.ValidateAndGetLength(NpgsqlBox, NpgsqlLengthCache, NpgsqlParameter)
    NpgsqlTypeHandler<NpgsqlBox>.ReadAsObject(NpgsqlReadBuffer, Int32, Boolean, FieldDescription)
    NpgsqlTypeHandler<NpgsqlBox>.GetFieldType(FieldDescription)
    NpgsqlTypeHandler<NpgsqlBox>.GetProviderSpecificFieldType(FieldDescription)
    NpgsqlTypeHandler<NpgsqlBox>.CreateArrayHandler(PostgresArrayType, ArrayNullabilityMode)
    NpgsqlTypeHandler<NpgsqlBox>.CreateRangeHandler(PostgresType)
    NpgsqlTypeHandler<NpgsqlBox>.CreateMultirangeHandler(PostgresMultirangeType)
    NpgsqlTypeHandler.PostgresType
    NpgsqlTypeHandler.Read<TAny>(NpgsqlReadBuffer, Int32, Boolean, FieldDescription)
    NpgsqlTypeHandler.Read<TAny>(NpgsqlReadBuffer, Int32, FieldDescription)
    NpgsqlTypeHandler.ReadCustom<TAny>(NpgsqlReadBuffer, Int32, Boolean, FieldDescription)
    NpgsqlTypeHandler.ValidateAndGetLength<TAny>(TAny, NpgsqlLengthCache, NpgsqlParameter)
    NpgsqlTypeHandler.ValidateAndGetLengthCustom<TAny>(TAny, NpgsqlLengthCache, NpgsqlParameter)
    NpgsqlTypeHandler.WriteWithLength<TAny>(TAny, NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, Boolean, CancellationToken)
    NpgsqlTypeHandler.WriteWithLengthCustom<TAny>(TAny, NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, Boolean, CancellationToken)
    NpgsqlTypeHandler.ValidateObjectAndGetLength(Object, NpgsqlLengthCache, NpgsqlParameter)
    NpgsqlTypeHandler.WriteObjectWithLength(Object, NpgsqlWriteBuffer, NpgsqlLengthCache, NpgsqlParameter, Boolean, CancellationToken)
    NpgsqlTypeHandler.CreateConversionButNoParamException(Type)
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ReferenceEquals(Object, Object)
    Object.ToString()
    Namespace: Npgsql.Internal.TypeHandlers.GeometricHandlers
    Assembly: Npgsql.dll
    Syntax
    public class BoxHandler : NpgsqlSimpleTypeHandler<NpgsqlBox>, INpgsqlTypeHandler<NpgsqlBox>, INpgsqlSimpleTypeHandler<NpgsqlBox>
    Remarks

    See https://www.postgresql.org/docs/current/static/datatype-geometric.html.

    The type handler API allows customizing Npgsql's behavior in powerful ways. However, although it is public, it should be considered somewhat unstable, and may change in breaking ways, including in non-major releases. Use it at your own risk.

    Constructors

    BoxHandler(PostgresType)

    Declaration
    public BoxHandler(PostgresType pgType)
    Parameters
    Type Name Description
    PostgresType pgType

    Methods

    Read(NpgsqlReadBuffer, Int32, FieldDescription)

    Reads a value of type TDefault with the given length from the provided buffer, with the assumption that it is entirely present in the provided memory buffer and no I/O will be required.

    Declaration
    public override NpgsqlBox Read(NpgsqlReadBuffer buf, int len, FieldDescription fieldDescription = null)
    Parameters
    Type Name Description
    NpgsqlReadBuffer buf

    The buffer from which to read.

    Int32 len

    The byte length of the value. The buffer might not contain the full length, requiring I/O to be performed.

    FieldDescription fieldDescription

    Additional PostgreSQL information about the type, such as the length in varchar(30).

    Returns
    Type Description
    NpgsqlBox

    The fully-read value.

    Overrides
    Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler<NpgsqlTypes.NpgsqlBox>.Read(Npgsql.Internal.NpgsqlReadBuffer, System.Int32, Npgsql.BackendMessages.FieldDescription)

    ValidateAndGetLength(NpgsqlBox, NpgsqlParameter)

    Responsible for validating that a value represents a value of the correct and which can be written for PostgreSQL - if the value cannot be written for any reason, an exception shold be thrown. Also returns the byte length needed to write the value.

    Declaration
    public override int ValidateAndGetLength(NpgsqlBox value, NpgsqlParameter parameter)
    Parameters
    Type Name Description
    NpgsqlBox value
    NpgsqlParameter parameter

    The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size).

    Returns
    Type Description
    Int32

    The number of bytes required to write the value.

    Overrides
    Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler<NpgsqlTypes.NpgsqlBox>.ValidateAndGetLength(NpgsqlTypes.NpgsqlBox, Npgsql.NpgsqlParameter)

    Write(NpgsqlBox, NpgsqlWriteBuffer, NpgsqlParameter)

    Writes a value to the provided buffer, with the assumption that there is enough space in the buffer (no I/O will occur). The Npgsql core will have taken care of that.

    Declaration
    public override void Write(NpgsqlBox value, NpgsqlWriteBuffer buf, NpgsqlParameter parameter)
    Parameters
    Type Name Description
    NpgsqlBox value
    NpgsqlWriteBuffer buf

    The buffer to which to write.

    NpgsqlParameter parameter

    The NpgsqlParameter instance where this value resides. Can be used to access additional information relevant to the write process (e.g. Size).

    Overrides
    Npgsql.Internal.TypeHandling.NpgsqlSimpleTypeHandler<NpgsqlTypes.NpgsqlBox>.Write(NpgsqlTypes.NpgsqlBox, Npgsql.Internal.NpgsqlWriteBuffer, Npgsql.NpgsqlParameter)

    Implements

    INpgsqlTypeHandler<T>
    INpgsqlSimpleTypeHandler<T>
    In This Article
    Back to top © Copyright 2022 The Npgsql Development Team