1. Home
  2. API
  3. Markdig.Helpers
  4. StringSlice

StringSlice Struct

Definition

Namespace Markdig.Helpers
Assembly Markdig.dll
Implements ICharIterator
View source
Show inherited members (5)

A lightweight struct that represents a slice of a string.

public struct StringSlice : ICharIterator
Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (4)

StringSlice(String, NewLine)Initializes a new instance of the StringSlice struct.
StringSlice(String, Int32, Int32, NewLine)Initializes a new instance of the StringSlice struct.
StringSlice(String, Int32, Int32)Initializes a new instance of the StringSlice struct.
StringSlice(String)Initializes a new instance of the StringSlice struct.

Fields (3)

EmptyAn empty string slice.
NewLineGets or sets the new line.
TextThe text of this slice.

Properties (7)

CurrentCharGets the current character.
CurrentRuneGets the current Rune. Recognizes supplementary code points that cannot be covered by a single Char.
EndGets or sets the end position (inclusive) within Text.
IsEmptyGets a value indicating whether this instance is empty.
Item[Int32]Gets the Char at the specified index.
LengthGets the length.
StartGets or sets the start position within Text.

Methods (24)

AsSpan()Performs the as span operation.
IndexOf(Char)Searches for the specified character within this slice.
IndexOf(String, Int32, Boolean)Searches the specified text within this slice.
IsEmptyOrWhitespace()Determines whether this slice is empty or made only of whitespaces.
Match(String, Int32, Int32)Matches the specified text.
Match(String, Int32)Matches the specified text.
MatchLowercase(String, Int32, Int32)Matches the specified text using lowercase comparison.
MatchLowercase(String, Int32)Matches the specified text using lowercase comparison.
NextChar()Goes to the next character, incrementing the Start position.
NextRune()Goes to the next Rune, incrementing the Start position. If CurrentRune is a supplementary character, Start will be advanced by 2.
Overlaps(StringSlice)Performs the overlaps operation.
PeekChar()Peeks a character at the offset of 1 from the current Start position inside the range Start and End, returns `\0` if outside this range.
PeekChar(Int32)Peeks a character at the specified offset from the current Start position inside the range Start and End, returns `\0` if outside this range.
PeekCharAbsolute(Int32)Peeks a character at the specified offset from the current beginning of the string, without taking into account Start and End
PeekCharExtra(Int32)Peeks a character at the specified offset from the current beginning of the slice without using the range Start or End, returns `\0` if outside the Text.
PeekRuneExtra(Int32)Peeks a Rune at the specified offset from the current beginning of the slice without using the range Start or End, returns default if outside the Text. Recognizes supplementary code points that cannot be covered by a single Char. A positive offset value expects the high surrogate and a negative offset expects the low surrogate of the surrogate pair of a supplementary character at that position.
RuneAt(Int32)Gets the Rune at the specified index. Recognizes supplementary code points that cannot be covered by a single Char.
SkipChar()Goes to the next character, incrementing the Start position.
SkipSpacesToEndOfLineOrEndOfDocument()Expect spaces until a end of line. Return false otherwise.
ToString()Returns a String that represents this instance.
Trim()Trims whitespaces from both the start and end of this slice.
TrimEnd()Trims whitespaces at the end of this slice, starting from End position.
TrimStart()Trims whitespaces at the beginning of this slice starting from Start position.
TrimStart(out Int32)Trims whitespaces at the beginning of this slice starting from Start position.