StringSegmentExtensionsReadLine Method

Advances the specified rest parameter after the current line and returns the consumed part without the newline character(s). If rest started with a new line before the call, then an empty segment is returned. If the whole StringSegment has been processed, then rest will be StringSegment.Null after returning.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0

C#

public static StringSegment ReadLine(
	this ref StringSegment rest
)

VB

<ExtensionAttribute>
Public Shared Function ReadLine ( 
	ByRef rest As StringSegment
) As StringSegment

C++

public:
[ExtensionAttribute]
static StringSegment ReadLine(
	StringSegment% rest
)

F#

[<ExtensionAttribute>]
static member ReadLine : 
        rest : StringSegment byref -> StringSegment

Parameters

rest StringSegment: Represents the rest of the string to process. When this method returns, the value of this parameter will be the remaining unprocessed part, or StringSegment.Null if the whole segment has been processed.

Return Value

StringSegment
A StringSegment that contains the first line of the original value of the rest parameter, or the complete original value of rest if it contained no more lines.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type StringSegment. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The effect of this method is the same as calling the ReadToSeparator(StringSegment, String) method with "\r\n", "\r", "\n" parameters but it is implemented a bit more optimized way.