diff --git a/xml/System.Buffers.Binary/BinaryPrimitives.xml b/xml/System.Buffers.Binary/BinaryPrimitives.xml index c85cfe3fadc..564295a95e9 100644 --- a/xml/System.Buffers.Binary/BinaryPrimitives.xml +++ b/xml/System.Buffers.Binary/BinaryPrimitives.xml @@ -1655,9 +1655,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1686,9 +1686,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1717,9 +1717,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1748,9 +1748,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1779,9 +1779,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1816,9 +1816,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1890,9 +1890,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1927,9 +1927,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. @@ -1964,9 +1964,9 @@ This method effectively does nothing and was added only for consistency. - To be added. - To be added. - To be added. + The source span to copy. + The destination to which the source elements should be copied. + Copies every primitive value from to , reversing each primitive by performing an endianness swap as part of writing each. To be added. diff --git a/xml/System.Buffers.Text/Base64Url.xml b/xml/System.Buffers.Text/Base64Url.xml index 8e3752b9b85..4f8216bed17 100644 --- a/xml/System.Buffers.Text/Base64Url.xml +++ b/xml/System.Buffers.Text/Base64Url.xml @@ -43,10 +43,15 @@ - To be added. - To be added. - To be added. + The input span which contains ASCII chars in Base64Url that needs to be decoded. + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + A byte array which contains the result of the decoding operation. To be added. + + + contains a invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -69,11 +74,17 @@ - To be added. - To be added. - To be added. - To be added. + The input span which contains ASCII chars in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + The number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. To be added. + The buffer in is too small to hold the encoded output. + + + contains a invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -98,14 +109,24 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains unicode ASCII chars in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + When this method returns, contains the number of input chars consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. + When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + + + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . + + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + One of the enumeration values that indicates the success or failure of the operation. + + As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . + If the length is not a multiple of 4 and is the remainders decoded accordingly: + - Remainder of 3 chars - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 chars - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 char - will cause OperationStatus.InvalidData result. + @@ -133,10 +154,15 @@ - To be added. - To be added. - To be added. + The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + >A byte array which contains the result of the decoding operation. To be added. + + + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -159,11 +185,23 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + The number of bytes written into . This can be used to slice the output for subsequent calls, if necessary. + + As padding is optional for Base64Url the length not required to be a multiple of 4. + If the length is not a multiple of 4 the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - is invalid input, causes FormatException. + + The buffer in is too small to hold the encoded output. + + + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -188,14 +226,24 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. + When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + + + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop. Calls with should be followed up with another call where this parameter is call. The default is . + + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + One of the enumeration values that indicates the success or failure of the operation. + + As padding is optional for Base64Url the length not required to be a multiple of 4 even if is . + If the length is not a multiple of 4 and is the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - will cause OperationStatus.InvalidData result. + @@ -217,10 +265,24 @@ - To be added. - To be added. - To be added. - To be added. + The input span which contains the base 64 text data that needs to be decoded. + + Decodes the span of UTF-8 encoded text in Base64Url into binary data, in-place. + The decoded binary output is smaller than the text data contained in the input (the operation deflates the data). + + The number of bytes written into . This can be used to slice the output for subsequent calls, if necessary. + + As padding is optional for Base64Url the length not required to be a multiple of 4. + If the length is not a multiple of 4 the remainders decoded accordingly: + - Remainder of 3 bytes - decoded into 2 bytes data, decoding succeeds. + - Remainder of 2 bytes - decoded into 1 byte data. decoding succeeds. + - Remainder of 1 byte - is invalid input, causes FormatException. + + + + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -248,10 +310,10 @@ - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + A char array which contains the result of the operation, i.e. the ASCII chars in Base64Url. + This implementation of the base64url encoding omits the optional padding characters. @@ -274,11 +336,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary. + This implementation of the base64url encoding omits the optional padding characters. + The buffer in is too small to hold the encoded output. @@ -303,14 +366,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. + >When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. + >When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + + + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop, subsequent calls with should end with call. The default is . + + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + One of the enumeration values that indicates the success or failure of the operation. + This implementation of the base64url encoding omits the optional padding characters. @@ -338,10 +405,10 @@ - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + Encodes the span of binary data into unicode string represented as Base64Url ASCII chars. + A string which contains the result of the operation, i.e. the ASCII string in Base64Url. + This implementation of the base64url encoding omits the optional padding characters. @@ -369,10 +436,10 @@ - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + The output byte array which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. + This implementation of the base64url encoding omits the optional padding characters. @@ -395,11 +462,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + The number of bytes written into the destination span. This can be used to slice the output for subsequent calls, if necessary. + This implementation of the base64url encoding omits the optional padding characters. + The buffer in is too small to hold the encoded output. @@ -424,14 +492,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. + When this method returns, contains the number of input bytes consumed during the operation. This can be used to slice the input for subsequent calls, if necessary. This parameter is treated as uninitialized. + When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + + + when the input span contains the entirety of data to encode; when more data may follow, + such as when calling in a loop, subsequent calls with should end with call. The default is . + + Encodes the span of binary data into UTF-8 encoded text represented as Base64Url. + One of the enumeration values that indicates the success or failure of the operation. + This implementation of the base64url encoding omits the optional padding characters. @@ -454,9 +526,11 @@ To be added. - To be added. + Returns the length (in bytes) of the result if you were to encode binary data within a byte span of size . To be added. To be added. + + is less than 0 or greater than 1610612733. @@ -479,9 +553,10 @@ To be added. - To be added. + Returns the maximum length (in bytes) of the result if you were to decode base 64 encoded text from a span of size . To be added. To be added. + The specified is less than 0. @@ -503,10 +578,11 @@ - To be added. - To be added. - To be added. - To be added. + A span of UTF-8 text to validate. + Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data. + + if contains a valid, decodable sequence of base-64 encoded data; otherwise, . + where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). @@ -528,10 +604,17 @@ - To be added. - To be added. - To be added. - To be added. + A span of text to validate. + Validates that the specified span of text is comprised of valid base-64 encoded data. + + if contains a valid, decodable sequence of base-64 encoded data; otherwise, . + + If the method returns , the same text passed to and + + would successfully decode (in the case + of assuming sufficient output space). + Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. + @@ -554,11 +637,12 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A span of UTF-8 text to validate. + If the method returns , the number of decoded bytes that will result from decoding the input UTF-8 text. + Validates that the specified span of UTF-8 text is comprised of valid base-64 encoded data. + + if contains a valid, decodable sequence of base-64 encoded data; otherwise, . + where whitespace is defined as the characters ' ', '\t', '\r', or '\n' (as bytes). @@ -581,11 +665,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + A span of text to validate. + If the method returns , the number of decoded bytes that will result from decoding the input text. + Validates that the specified span of text is comprised of valid base-64 encoded data. + + if contains a valid, decodable sequence of base-64 encoded data; otherwise, . + + If the method returns , the same text passed to and + + would successfully decode (in the case + of assuming sufficient output space). + Any amount of whitespace is allowed anywhere in the input, where whitespace is defined as the characters ' ', '\t', '\r', or '\n'. + @@ -609,12 +700,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains ASCII chars in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + Decodes the span of unicode ASCII chars represented as Base64Url into binary data. + + if bytes decoded successfully, otherwise . To be added. + + + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -638,12 +735,18 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains UTF-8 encoded text in Base64Url that needs to be decoded. + The output span which contains the result of the operation, i.e. the decoded binary data. + When this method returns, contains the number of bytes written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + Decodes the span of UTF-8 encoded text represented as Base64Url into binary data. + + if bytes decoded successfully, otherwise . To be added. + + + contains an invalid Base64Url character, + more than two padding characters, or a non white space character among the padding characters. + @@ -667,12 +770,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the ASCII chars in Base64Url. + When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + Encodes the span of binary data into unicode ASCII chars represented as Base64Url. + + if chars encoded successfully, otherwise . + This implementation of the base64url encoding omits the optional padding characters. @@ -696,12 +800,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + The input span which contains binary data that needs to be encoded. + The output span which contains the result of the operation, i.e. the UTF-8 encoded text in Base64Url. + When this method returns, contains the number of chars written into the output span. This can be used to slice the output for subsequent calls, if necessary. This parameter is treated as uninitialized. + Encodes the span of binary data into UTF-8 encoded chars represented as Base64Url. + + if bytes encoded successfully, otherwise . + This implementation of the base64url encoding omits the optional padding characters. @@ -725,12 +830,22 @@ - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + + The input span which contains binary data that needs to be encoded. + It needs to be large enough to fit the result of the operation. + + + The amount of binary data contained within the buffer that needs to be encoded + (and needs to be smaller than the buffer length). + + When this method returns, contains the number of bytes written into the buffer. This parameter is treated as uninitialized. + + Encodes the span of binary data (in-place) into UTF-8 encoded text represented as base 64. + The encoded text output is larger than the binary data contained in the input (the operation inflates the data). + + + if bytes encoded successfully, otherwise . + This implementation of the base64url encoding omits the optional padding characters. diff --git a/xml/System.Buffers/NIndex.xml b/xml/System.Buffers/NIndex.xml index 3c0afe74708..279d20f1540 100644 --- a/xml/System.Buffers/NIndex.xml +++ b/xml/System.Buffers/NIndex.xml @@ -24,8 +24,14 @@ - To be added. + Represent a type can be used to index a collection either from the start or the end. To be added. + + +int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ; +int lastElement = someArray[^1]; // lastElement = 5 + + @@ -44,9 +50,9 @@ - To be added. - To be added. - To be added. + The to create the from. + Construct a from a + If the NIndex constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. @@ -65,10 +71,10 @@ - To be added. - To be added. - To be added. - To be added. + The index value. it has to be zero or positive number. + Indicating if the index is from the start or from the end. + Construct an NIndex using a value and indicating if the NIndex is from the start or from the end. + If the NIndex constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element. @@ -87,7 +93,7 @@ System.Buffers.NIndex - To be added. + Create an NIndex pointing at beyond last element. To be added. To be added. @@ -114,8 +120,8 @@ - To be added. - To be added. + An object to compare with this object + Indicates whether the current NIndex object is equal to another NIndex object. To be added. To be added. @@ -152,8 +158,8 @@ - To be added. - To be added. + An object to compare with this object + Indicates whether the current NIndex object is equal to another object of the same type. To be added. To be added. @@ -177,8 +183,8 @@ - To be added. - To be added. + The index value from the end. + Create an NIndex from the end at the position indicated by the value. To be added. To be added. @@ -202,8 +208,8 @@ - To be added. - To be added. + The index value from the start. + Create an NIndex from the start at the position indicated by the value. To be added. To be added. @@ -225,7 +231,7 @@ - To be added. + Returns the hash code for this instance. To be added. To be added. @@ -249,10 +255,15 @@ - To be added. - To be added. + The length of the collection that the NIndex will be used with. length has to be a positive value + Calculate the offset from the start using the giving collection length. To be added. - To be added. + + 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 NIndex will be used with collections which always have non negative length/count. If the returned offset is negative and + then used to NIndex a collection will get out of range exception which will be same affect as the validation. + @@ -271,7 +282,7 @@ System.Boolean - To be added. + Indicates whether the NIndex is from the start or the end. To be added. To be added. @@ -321,7 +332,7 @@ To be added. - To be added. + Converts a to an ."/> To be added. To be added. @@ -346,7 +357,7 @@ To be added. - To be added. + Converts native integer number to an NIndex. To be added. To be added. @@ -371,7 +382,7 @@ To be added. - To be added. + Converts integer number to an NIndex. To be added. To be added. @@ -392,7 +403,7 @@ System.Buffers.NIndex - To be added. + Create an NIndex pointing at first element. To be added. To be added. @@ -464,7 +475,7 @@ - To be added. + Converts the value of the current NIndex object to its equivalent string representation. To be added. To be added. @@ -485,7 +496,7 @@ System.IntPtr - To be added. + Returns the NIndex value. To be added. To be added. diff --git a/xml/System.Buffers/NRange.xml b/xml/System.Buffers/NRange.xml index fb75c51148b..f34eb916aa0 100644 --- a/xml/System.Buffers/NRange.xml +++ b/xml/System.Buffers/NRange.xml @@ -24,8 +24,8 @@ - To be added. - To be added. + Represent a range that has start and end indices. + <para><code></para><para>int[] someArray = new int[5] { 1, 2, 3, 4, 5 };</para><para>int[] subArray1 = someArray[0..2]; // { 1, 2 }</para><para>int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }</para><para></code></para> @@ -44,8 +44,8 @@ - To be added. - To be added. + The to use. + Construct a object using a . To be added. @@ -66,9 +66,9 @@ - To be added. - To be added. - To be added. + Represent the inclusive start NIndex of the NRange. + Represent the exclusive end NIndex of the NRange. + Construct an NRange object using the start and end NIndexes. To be added. @@ -88,7 +88,7 @@ System.Buffers.NRange - To be added. + Create an NRange object starting from first element to the end. To be added. To be added. @@ -109,7 +109,7 @@ System.Buffers.NIndex - To be added. + Represent the exclusive end NIndex of the NRange. To be added. To be added. @@ -134,7 +134,7 @@ To be added. - To be added. + Create an NRange object starting from first element in the collection to the end NIndex. To be added. To be added. @@ -161,8 +161,8 @@ - To be added. - To be added. + An object to compare with this object + Indicates whether the current NRange object is equal to another NRange object. To be added. To be added. @@ -199,8 +199,8 @@ - To be added. - To be added. + An object to compare with this object + Indicates whether the current NRange object is equal to another object of the same type. To be added. To be added. @@ -222,7 +222,7 @@ - To be added. + Returns the hash code for this instance. To be added. To be added. @@ -252,10 +252,14 @@ - To be added. - To be added. + The length of the collection that the NRange will be used with. length has to be a positive value. + Calculate the start offset and length of NRange object using a collection length. To be added. - To be added. + + For performance reason, we don't validate the input length parameter against negative values. + It is expected NRange will be used with collections which always have non negative length/count. + We validate the NRange is inside the length scope though. + @@ -349,7 +353,7 @@ System.Buffers.NIndex - To be added. + Represent the inclusive start NIndex of the NRange. To be added. To be added. @@ -374,7 +378,7 @@ To be added. - To be added. + Create an NRange object starting from start NIndex to the end of the collection. To be added. To be added. @@ -446,7 +450,7 @@ - To be added. + Converts the value of the current NRange object to its equivalent string representation. To be added. To be added. diff --git a/xml/System.Buffers/SearchValues.xml b/xml/System.Buffers/SearchValues.xml index 88eaa6e4d5d..0dab8fcf7ab 100644 --- a/xml/System.Buffers/SearchValues.xml +++ b/xml/System.Buffers/SearchValues.xml @@ -141,11 +141,11 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The set of values. + Specifies whether to use or search semantics. + Creates an optimized representation of used for efficient searching. + The optimized representation of used for efficient searching. + Only or may be used.