/*
 * Copyright 2018 The Cartographer Authors
 *
 * 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.
 */

namespace CartographerSharp.IO;

/// <summary>
/// Interface for reading proto messages from a pbstream.
/// </summary>
public interface IProtoStreamReader
{
    /// <summary>
    /// Deserializes compressed proto from the pb stream.
    /// </summary>
    bool ReadProto<T>(out T? proto);

    /// <summary>
    /// 'End-of-file' marker for the pb stream.
    /// </summary>
    bool Eof { get; }
}