/*
 * Copyright 2016 higherfrequencytrading.com
 *
 * 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 net.openhft.lang.io.serialization;

import net.openhft.lang.io.Bytes;
import net.openhft.lang.model.constraints.NotNull;

/**
 * Integrated marshaller for objects.
 *
 * @author peter.lawrey
 * @see BytesMarshaller
 */
public interface BytesMarshallable {
    /**
     * read an object from bytes
     *
     * @param in to read from
     * @throws IllegalStateException if the object could not be read.
     */
    void readMarshallable(@NotNull Bytes in) throws IllegalStateException;

    /**
     * write an object to bytes
     *
     * @param out to write to
     */
    void writeMarshallable(@NotNull Bytes out);
}