/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.ignite.raft.jraft.entity.codec;

import java.nio.ByteBuffer;
import org.apache.ignite.raft.jraft.entity.LogEntry;

/**
 * Log entry encoder
 */
public interface LogEntryEncoder {
    /**
     * Encode a log entry into a byte array.
     *
     * @param log log entry
     * @return encoded byte array
     */
    byte[] encode(LogEntry log);

    /**
     * Same as {@link #encode(LogEntry)} but writes the result into a buffer.
     *
     * @param buffer Buffer to write into. The buffer must be large enough to hold the encoded log entry.
     * @param log Log entry.
     */
    void encode(ByteBuffer buffer, LogEntry log);

    /**
     * Returns the size in bytes of an encoded log entry.
     */
    int size(LogEntry logEntry);
}
