What's the correct way to break the PipeReader loop?

[GF-Huang]

This page show many incorrect demonstrations.

But what's the correct way?

Is this the only correct way?

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 2f5384a7-5e96-d977-7748-317a2c758f63
• Version Independent ID: 06e72212-a052-a351-0e0b-1b002ce214de
• Content: I/O pipelines - .NET
• Content Source: docs/standard/io/pipelines.md
• Product: dotnet-fundamentals
• GitHub Login: @Rick-Anderson
• Microsoft Alias: riande

---

Associated WorkItem - 564675

[davidfowl]

Yes assuming you want to throw for incomplete messages.

[GF-Huang]

Yes assuming you want to throw for incomplete messages.

So, result.IsComplete && buffer.Length == 0 means all messages are read complete?

[davidfowl]

Yes but look at the examples. There are 2 code samples. One for reading a single message and one for reading many messages. The code is different depending on what you're trying to do.

[GF-Huang]

Yes but look at the examples. There are 2 code samples. One for reading a single message and one for reading many messages. The code is different depending on what you're trying to do.

I have another question is that why the single message example never call reader.Complete? Will this make memory leak?

[davidfowl]

When reading a single message at a time you don't want to complete the reader, that would mean you can't read anymore messages. In the case of reading a single message, the caller is responsible for completing the reader.

[GF-Huang]

Got it, thanks your guide.

[Rick-Anderson]

Opening as we can probably add some of this to the doc.