1 // Copyright 2021 The Pigweed Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not 4 // use this file except in compliance with the License. You may obtain a copy of 5 // the License at 6 // 7 // https://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 // License for the specific language governing permissions and limitations under 13 // the License. 14 #pragma once 15 16 #include <limits> 17 18 #include "pw_log/proto/log.pwpb.h" 19 #include "pw_multisink/multisink.h" 20 #include "pw_status/status.h" 21 22 namespace pw::multisink { 23 24 // Uses MultiSink's unsafe iteration to dump the contents as a series of log 25 // entries. max_num_entries can be used to limit the dump to the most recent 26 // entries. This can be used to dump proto-encoded logs to a 27 // pw.snapshot.Snapshot. 28 Status UnsafeDumpMultiSinkLogs( 29 MultiSink& sink, 30 pw::log::pwpb::LogEntries::StreamEncoder& encoder, 31 size_t max_num_entries = std::numeric_limits<size_t>::max()); 32 33 // Uses MultiSink's unsafe iteration to dump the contents as a series of log 34 // entries. max_size_bytes is the total size of the captured log entries. This 35 // can be used to dump proto-encoded logs to a pw.snapshot.Snapshot. 36 Status UnsafeDumpMultiSinkLogsFromEnd( 37 MultiSink& sink, 38 pw::log::pwpb::LogEntries::StreamEncoder& encoder, 39 size_t max_size_bytes); 40 41 } // namespace pw::multisink 42