xref: /aosp_15_r20/external/pigweed/pw_uart/public/pw_uart/stream.h (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1 // Copyright 2024 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 
15 #pragma once
16 
17 #include "pw_stream/stream.h"
18 #include "pw_uart/uart.h"
19 
20 namespace pw::uart {
21 
22 /// UartStream implements the pw::stream::NonSeekableReaderWriter
23 /// interface on top of a Uart device.
24 class UartStream final : public stream::NonSeekableReaderWriter {
25  public:
26   /// Constructs a UartStream for a Uart device.
UartStream(Uart & uart)27   UartStream(Uart& uart) : uart_(uart) {}
28 
29  private:
30   Uart& uart_;
31 
32   // NonSeekableReaderWriter impl.
DoRead(ByteSpan destination)33   StatusWithSize DoRead(ByteSpan destination) override {
34     return uart_.ReadAtLeast(destination, 1);
35   }
36 
DoWrite(ConstByteSpan data)37   Status DoWrite(ConstByteSpan data) override { return uart_.Write(data); }
38 };
39 
40 }  // namespace pw::uart
41