io.questdb.cairo.vm.api.MemoryW Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *     ___                  _   ____  ____
 *    / _ \ _   _  ___  ___| |_|  _ \| __ )
 *   | | | | | | |/ _ \/ __| __| | | |  _ \
 *   | |_| | |_| |  __/\__ \ |_| |_| | |_) |
 *    \__\_\\__,_|\___||___/\__|____/|____/
 *
 *  Copyright (c) 2014-2019 Appsicle
 *  Copyright (c) 2019-2024 QuestDB
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 ******************************************************************************/

package io.questdb.cairo.vm.api;

import io.questdb.std.Long256;
import io.questdb.std.str.Utf8Sequence;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.Closeable;

//writable
public interface MemoryW extends Closeable {

    long appendAddressFor(long offset, long bytes);

    @Override
    void close();

    void putBool(long offset, boolean value);

    void putByte(long offset, byte value);

    void putChar(long offset, char value);

    void putDouble(long offset, double value);

    void putFloat(long offset, float value);

    void putInt(long offset, int value);

    void putLong(long offset, long value);

    void putLong256(long offset, Long256 value);

    void putLong256(long offset, long l0, long l1, long l2, long l3);

    void putNullStr(long offset);

    void putShort(long offset, short value);

    void putStr(long offset, CharSequence value);

    void putStr(long offset, CharSequence value, int pos, int len);

    /**
     * Appends UTF8 sequence bytes to the memory. The binary format is bytes
     * only. Length to be encoded elsewhere.
     *
     * @param value any utf8 sequence
     */
    default void putVarchar(long offset, @Nullable Utf8Sequence value) {
        if (value != null) {
            putVarchar(offset, value, 0, value.size());
        }
    }

    void putVarchar(long offset, @NotNull Utf8Sequence value, int lo, int hi);

    void truncate();

    void zero();
}