Microsoft.Extensions.Primitives.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Extensions.Primitives</name> </assembly> <members> <member name="T:Microsoft.Extensions.Primitives.CancellationChangeToken"> <summary> A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> implementation using <see cref="T:System.Threading.CancellationToken"/>. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.#ctor(System.Threading.CancellationToken)"> <summary> Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.CancellationChangeToken"/>. </summary> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param> </member> <member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.ActiveChangeCallbacks"> <inheritdoc /> </member> <member name="P:Microsoft.Extensions.Primitives.CancellationChangeToken.HasChanged"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.Primitives.CancellationChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)"> <inheritdoc /> </member> <member name="T:Microsoft.Extensions.Primitives.ChangeToken"> <summary> Propagates notifications that a change has occured. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action)"> <summary> Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes. </summary> <param name="changeTokenProducer">Produces the change token.</param> <param name="changeTokenConsumer">Action called when the token changes.</param> <returns></returns> </member> <member name="M:Microsoft.Extensions.Primitives.ChangeToken.OnChange``1(System.Func{Microsoft.Extensions.Primitives.IChangeToken},System.Action{``0},``0)"> <summary> Registers the <paramref name="changeTokenConsumer"/> action to be called whenever the token produced changes. </summary> <param name="changeTokenProducer">Produces the change token.</param> <param name="changeTokenConsumer">Action called when the token changes.</param> <param name="state">state for the consumer.</param> <returns></returns> </member> <member name="T:Microsoft.Extensions.Primitives.IChangeToken"> <summary> Propagates notifications that a change has occured. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"> <summary> Gets a value that indicates if a change has occured. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks"> <summary> Indicates if this token will pro-actively raise callbacks. Callbacks are still guaranteed to fire, eventually. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.IChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)"> <summary> Registers for a callback that will be invoked when the entry has changed. <see cref="P:Microsoft.Extensions.Primitives.IChangeToken.HasChanged"/> MUST be set before the callback is invoked. </summary> <param name="callback">The <see cref="T:System.Action`1"/> to invoke.</param> <param name="state">State to be passed into the callback.</param> <returns>An <see cref="T:System.IDisposable"/> that is used to unregister the callback.</returns> </member> <member name="T:Microsoft.Extensions.Primitives.Resources"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.Resources.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.Resources.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.Resources.Argument_InvalidOffsetLength"> <summary> Looks up a localized string similar to Offset and length are out of bounds for the string or length is greater than the number of characters from index to the end of the string.. </summary> </member> <member name="T:Microsoft.Extensions.Primitives.StringSegment"> <summary> An optimized representation of a substring. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String)"> <summary> Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct. </summary> <param name="buffer"> The original <see cref="T:System.String"/>. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> includes the whole <see cref="T:System.String"/>. </param> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.#ctor(System.String,System.Int32,System.Int32)"> <summary> Initializes an instance of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> struct. </summary> <param name="buffer">The original <see cref="T:System.String"/> used as buffer.</param> <param name="offset">The offset of the segment within the <paramref name="buffer"/>.</param> <param name="length">The length of the segment.</param> </member> <member name="P:Microsoft.Extensions.Primitives.StringSegment.Buffer"> <summary> Gets the <see cref="T:System.String"/> buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.StringSegment.Offset"> <summary> Gets the offset within the buffer for this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.StringSegment.Length"> <summary> Gets the length of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.StringSegment.Value"> <summary> Gets the value of this segment as a <see cref="T:System.String"/>. </summary> </member> <member name="P:Microsoft.Extensions.Primitives.StringSegment.HasValue"> <summary> Gets whether or not this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> contains a valid value. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.Object)"> <inheritdoc /> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment)"> <summary> Indicates whether the current object is equal to another object of the same type. </summary> <param name="other">An object to compare with this object.</param> <returns><code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(Microsoft.Extensions.Primitives.StringSegment,System.StringComparison)"> <summary> Indicates whether the current object is equal to another object of the same type. </summary> <param name="other">An object to compare with this object.</param> <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param> <returns><code>true</code> if the current object is equal to the other parameter; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String)"> <summary> Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> <param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param> <returns><code>true</code> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Equals(System.String,System.StringComparison)"> <summary> Checks if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> <param name="text">The <see cref="T:System.String"/> to compare with the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param> <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param> <returns><code>true</code> if the specified <see cref="T:System.String"/> is equal to the current <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.GetHashCode"> <inheritdoc /> <remarks> This GetHashCode is expensive since it allocates on every call. However this is required to ensure we retain any behavior (such as hash code randomization) that string.GetHashCode has. </remarks> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Equality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)"> <summary> Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have the same value. </summary> <param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param> <param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param> <returns><code>true</code> if the value of <paramref name="left"/> is the same as the value of <paramref name="right"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.op_Inequality(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Extensions.Primitives.StringSegment)"> <summary> Checks if two specified <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> have different values. </summary> <param name="left">The first <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param> <param name="right">The second <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> to compare, or <code>null</code>.</param> <returns><code>true</code> if the value of <paramref name="left"/> is different from the value of <paramref name="right"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.StartsWith(System.String,System.StringComparison)"> <summary> Checks if the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>. </summary> <param name="text">The <see cref="T:System.String"/>to compare.</param> <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param> <returns><code>true</code> if <paramref name="text"/> matches the beginning of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.EndsWith(System.String,System.StringComparison)"> <summary> Checks if the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> matches the specified <see cref="T:System.String"/> when compared using the specified <paramref name="comparisonType"/>. </summary> <param name="text">The <see cref="T:System.String"/>to compare.</param> <param name="comparisonType">One of the enumeration values that specifies the rules to use in the comparison.</param> <returns><code>true</code> if <paramref name="text"/> matches the end of this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>; otherwise, <code>false</code>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Substring(System.Int32,System.Int32)"> <summary> Retrieves a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. The substring starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>. </summary> <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param> <param name="length">The number of characters in the substring.</param> <returns>A <see cref="T:System.String"/> that is equivalent to the substring of length <paramref name="length"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Subsegment(System.Int32,System.Int32)"> <summary> Retrieves a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that represents a substring from this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> starts at the position specified by <paramref name="offset"/> and has the specified <paramref name="length"/>. </summary> <param name="offset">The zero-based starting character position of a substring in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</param> <param name="length">The number of characters in the substring.</param> <returns>A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> that is equivalent to the substring of length <paramref name="length"/> that begins at <paramref name="offset"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/></returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32,System.Int32)"> <summary> Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. The search starts at <paramref name="start"/> and examines a specified number of <paramref name="count"/> character positions. </summary> <param name="c">The Unicode character to seek.</param> <param name="start">The zero-based index position at which the search starts. </param> <param name="count">The number of characters to examine.</param> <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char,System.Int32)"> <summary> Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. The search starts at <paramref name="start"/>. </summary> <param name="c">The Unicode character to seek.</param> <param name="start">The zero-based index position at which the search starts. </param> <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.IndexOf(System.Char)"> <summary> Gets the zero-based index of the first occurrence of the character <paramref name="c"/> in this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>. </summary> <param name="c">The Unicode character to seek.</param> <returns>The zero-based index position of <paramref name="c"/> from the beginning of the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> if that character is found, or -1 if it is not.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.Trim"> <summary> Removes all leading and trailing whitespaces. </summary> <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimStart"> <summary> Removes all leading whitespaces. </summary> <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.TrimEnd"> <summary> Removes all trailing whitespaces. </summary> <returns>The trimmed <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>.</returns> </member> <member name="M:Microsoft.Extensions.Primitives.StringSegment.ToString"> <summary> Returns the <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value. </summary> <returns>The <see cref="T:System.String"/> represented by this <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> or <code>String.Empty</code> if the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> does not contain a value.</returns> </member> <member name="T:Microsoft.Extensions.Primitives.StringTokenizer"> <summary> Tokenizes a <c>string</c> into <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/>s. </summary> </member> <member name="M:Microsoft.Extensions.Primitives.StringTokenizer.#ctor(System.String,System.Char[])"> <summary> Initializes a new instance of <see cref="T:Microsoft.Extensions.Primitives.StringTokenizer"/>. </summary> <param name="value">The <c>string</c> to tokenize.</param> <param name="separators">The characters to tokenize by.</param> </member> <member name="T:Microsoft.Extensions.Primitives.StringValues"> <summary> Represents zero/null, one, or many strings in an efficient way. </summary> </member> </members> </doc> |