Microsoft.AspNetCore.Razor.Utilities.Shared

Reserved to be used by the compiler for tracking metadata. This class should not be used by developers in source code. This dummy class is required to compile records when targeting .NET Standard

Indicates that compiler support for a particular feature is required for the location where this attribute is applied.

The name of the compiler feature.

If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand .

Indicates which arguments to a method involving an interpolated string handler should be passed to that handler.

Initializes a new instance of the class.

The name of the argument that should be passed to the handler. The empty string may be used as the name of the receiver in an instance method.

Initializes a new instance of the class.

The names of the arguments that should be passed to the handler. The empty string may be used as the name of the receiver in an instance method.

Gets the names of the arguments that should be passed to the handler.

The empty string may be used as the name of the receiver in an instance method.

Indicates the attributed type is to be used as an interpolated string handler.

Initializes the .

Specifies that a type has required members or that a member is required.

Represents a heap-based, array-backed output sink into which data can be written.

Creates an instance of an , in which data can be written to, with the default initial capacity.

Creates an instance of an , in which data can be written to, with an initial capacity specified.

The minimum capacity with which to initialize the underlying buffer. Thrown when is not positive (i.e. less than or equal to 0).

Returns the data written to the underlying buffer so far, as a .

Returns the amount of data written to the underlying buffer so far.

Returns the total amount of space within the underlying buffer.

Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.

Clears the data written to the underlying buffer.

You must reset or clear the before trying to re-use it. The method is faster since it only sets to zero the writer's index while the method additionally zeroes the content of the underlying buffer.

Resets the data written to the underlying buffer without zeroing its content.

You must reset or clear the before trying to re-use it. If you reset the writer using the method, the underlying buffer will not be cleared.

Notifies that amount of data was written to the output /

Thrown when is negative. Thrown when attempting to advance past the end of the underlying buffer. You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.

Returns a to write to that is at least the requested length (specified by ). If no is provided (or it's equal to 0), some non-empty buffer is returned.

Thrown when is negative. This will never return an empty . There is no guarantee that successive calls will return the same buffer or the same-sized buffer. You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer. If you reset the writer using the method, this method may return a non-cleared . If you clear the writer using the method, this method will return a with its content zeroed.

Returns a to write to that is at least the requested length (specified by ). If no is provided (or it's equal to 0), some non-empty buffer is returned.

Deconstructs a into out variables. Provides support for assignment like


            var (k,v) = kvp;

extension methods

Returns an empty array if the input array is null (default)

Returns the current contents as an and sets the collection to a zero length array.

If equals , the internal array will be extracted as an without copying the contents. Otherwise, the contents will be copied into a new array. The collection will then be set to a zero-length array. An immutable array.

Represent a type can be used to index a collection either from the start or the end.

Index is used by the C# compiler to support the new index syntax


            int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
            int lastElement = someArray[^1]; // lastElement = 5

Construct an Index using a value and indicating if the index is from the start or from the end.

The index value. it has to be zero or positive number. Indicating if the index is from the start or from the end. If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.

Create an Index pointing at first element.

Create an Index pointing at beyond last element.

Create an Index from the start at the position indicated by the value.

The index value from the start.

Create an Index from the end at the position indicated by the value.

The index value from the end.

Returns the index value.

Indicates whether the index is from the start or the end.

Calculate the offset from the start using the giving collection length.

The length of the collection that the Index will be used with. length has to be a positive value For performance reason, we don't validate the input length parameter and the returned offset value against negative values. we don't validate either the returned offset is greater than the input length. It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and then used to index a collection will get out of range exception which will be same affect as the validation.

Indicates whether the current Index object is equal to another object of the same type.

An object to compare with this object

Indicates whether the current Index object is equal to another Index object.

An object to compare with this object

Returns the hash code for this instance.

Converts integer number to an Index.

Converts the value of the current Index object to its equivalent string representation.

Specifies that null is allowed as an input even if the corresponding type disallows it.

Specifies that null is disallowed as an input even if the corresponding type allows it.

Specifies that an output may be null even if the corresponding type disallows it.

Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.

Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter may be null.

Gets the return value condition.

Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.

Initializes the attribute with the specified return value condition.

The return value condition. If the method returns this value, the associated parameter will not be null.

Gets the return value condition.

Specifies that the output will be non-null if the named parameter is non-null.

Initializes the attribute with the associated parameter name.

The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.

Gets the associated parameter name.

Applied to a method that will never return under any circumstance.

Specifies that the method will not return if the associated Boolean parameter is passed the specified value.

Initializes the attribute with the specified parameter value.

The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to the associated parameter matches this value.

Gets the condition parameter value.

Specifies that the method or property will ensure that the listed field and property members have not-null values.

Initializes the attribute with a field or property member.

The field or property member that is promised to be not-null.

Initializes the attribute with the list of field and property members.

The list of field and property members that are promised to be not-null.

Gets field or property member names.

Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.

Initializes the attribute with the specified return value condition and a field or property member.

The return value condition. If the method returns this value, the associated parameter will not be null. The field or property member that is promised to be not-null.

Initializes the attribute with the specified return value condition and list of field and property members.

The return value condition. If the method returns this value, the associated parameter will not be null. The list of field and property members that are promised to be not-null.

Gets the return value condition.

Gets field or property member names.

Specifies that this constructor sets all required members for the current type, and callers do not need to set any required members themselves.

Represent a range has start and end indexes.

Range is used by the C# compiler to support the range syntax.


            int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
            int[] subArray1 = someArray[0..2]; // { 1, 2 }
            int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }

Represent the inclusive start index of the Range.

Represent the exclusive end index of the Range.

Construct a Range object using the start and end indexes.

Represent the inclusive start index of the range. Represent the exclusive end index of the range.

Indicates whether the current Range object is equal to another object of the same type.

An object to compare with this object

Indicates whether the current Range object is equal to another Range object.

An object to compare with this object

Returns the hash code for this instance.

Converts the value of the current Range object to its equivalent string representation.

Create a Range object starting from start index to the end of the collection.

Create a Range object starting from first element in the collection to the end Index.

Create a Range object starting from first element to the end.

Calculate the start offset and length of range object using a collection length.

The length of the collection that the range will be used with. length has to be a positive value. For performance reason, we don't validate the input length parameter against negative values. It is expected Range will be used with collections which always have non negative length/count. We validate the range is inside the length scope though.

Executes a binary search over an array, but allows the caller to decide what constitutes a match

Type of the elements in the array Type of the argument to pass to the comparer The array to search An argument to pass to the comparison function A comparison function that evaluates an item in the array. Return 0 if the item is a match, or -1 if the item indicates a successful match will be found in the left branch, or 1 if the item indicates a successful match will be found in the right branch. The index of the element found

Can be called at points that are assumed to be unreachable at runtime.

Set the 's capacity if it is less than .

Copies the elements of the to a new array, or returns an empty array if the is null.

On .NET Framework, will create a new empty array for any empty . This method avoids that extra allocation.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances that compares items using default equality.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

Gets a mutable reference to a stored in a using variable.

This supporting method allows , a non-copyable implementing , to be used with using statements while still allowing them to be passed by reference in calls. The following two calls are equivalent:


             using var array = PooledArrayBuilder<T>.Empty;
            
             // Using the 'Unsafe.AsRef' method
             Method(ref Unsafe.AsRef(in builder));
            
             // Using this helper method
             Method(ref builder.AsRef());

⚠ Do not move or rename this method without updating the corresponding Razor.Diagnostics.Analyzers\PooledArrayBuilderAsRefAnalyzer.cs. The type of element stored in the pooled array builder. A read-only reference to a pooled array builder which is part of a using statement. A mutable reference to the pooled array builder.

Wraps a pooled but doesn't allocate it until it's needed. Note: Dispose this to ensure that the pooled array builder is returned to the pool. There is significant effort to avoid retrieving the . For very small arrays of length 4 or less, the elements will be stored on the stack. If the array grows larger than 4 elements, a builder will be employed. Afterward, the build will continue to be used, even if the arrays shrinks and has fewer than 4 elements.

The number of items that can be stored inline.

A builder to be used as storage after the first time that the number of items exceeds . Once the builder is used, it is still used even if the number of items shrinks below . Essentially, if this field is non-null, it will be used as storage.

An optional initial capacity for the builder.

The number of inline elements. Note that this value is only used when is .

Returns the current contents as an and sets the collection to a zero length array.

This is present to help the JIT inline methods that need to throw a .

Wraps a pooled but doesn't allocate it until it's needed. Note: Dispose this to ensure that the pooled array builder is returned to the pool.

Wraps a pooled but doesn't allocate it until it's needed. Note: Dispose this to ensure that the pooled set is returned to the pool.

Wraps a pooled but doesn't allocate it until it's needed. Note: Dispose this to ensure that the pooled list is returned to the pool.

A pool of instances that compares items using reference equality.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

Pooled instances when the key is of type .

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

A pool of instances that compares strings.

Instances originating from this pool are intended to be short-lived and are suitable for temporary work. Do not return them as the results of methods or store them in fields.

Cannot advance past the end of the buffer, which has a size of {0}.

Cannot allocate a buffer of size {0}.

Destination is too short.

Non-negative number required.

This program location is thought to be unreachable. File='{0}', Line={1}