LogWriter.h

Go to the documentation of this file.

/*
 * Copyright 2017-present Facebook, Inc.
 *
 * 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.
 */
#pragma once

#include <folly/Range.h>

namespace folly {

class LogWriter {
 public:
  enum Flags : uint32_t {
    NO_FLAGS = 0x00,
    NEVER_DISCARD = 0x01,
  };

  virtual ~LogWriter() {}

  virtual void writeMessage(folly::StringPiece buffer, uint32_t flags = 0) = 0;

  virtual void writeMessage(std::string&& buffer, uint32_t flags = 0) {
    writeMessage(folly::StringPiece{buffer}, flags);
  }

  virtual void flush() = 0;

  virtual bool ttyOutput() const = 0;
};
} // namespace folly