Skip to content

Commit dfbbfdb

Browse files
authored
CBOR and platform check API updates (dotnet#4992)
1 parent c2502fc commit dfbbfdb

File tree

5 files changed

+105
-105
lines changed

5 files changed

+105
-105
lines changed

xml/System.Formats.Cbor/CborContentException.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>The exception that's thrown when CBOR data is invalid.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>

xml/System.Formats.Cbor/CborReader.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>A stateful, forward-only reader for CBOR encoded data.</summary>
17+
<summary>A stateful, forward-only reader for Concise Binary Object Representation (CBOR) encoded data.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -428,7 +428,7 @@ The next value uses a CBOR encoding that is not valid under the current conforma
428428

429429
The next date item does not have the correct semantic tag.</exception>
430430
<exception cref="T:System.OverflowException">Decoded decimal fraction is either too large or too small for a <see cref="T:System.Decimal" /> value.</exception>
431-
<exception cref="T:System.Formats.Cbor.CborContentException">The next value has an invalid CBOR encoding.
431+
<exception cref="T:System.Formats.Cbor.CborContentException">The next value has an invalid CBOR encoding.
432432

433433
-or-
434434

@@ -505,7 +505,7 @@ The next value uses a CBOR encoding that is not valid under the current conforma
505505

506506
The data item is an indefinite-length text string.</exception>
507507
<exception cref="T:System.Formats.Cbor.CborContentException">The next value has an invalid CBOR encoding.
508-
508+
509509
-or-
510510

511511
There was an unexpected end of CBOR encoding data.

xml/System.Formats.Cbor/CborWriter.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>A writer for CBOR encoded data.</summary>
17+
<summary>A writer for Concise Binary Object Representation (CBOR) encoded data.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -901,7 +901,7 @@ The written data is not accepted under the current conformance mode.</exception>
901901
<Docs>
902902
<summary>Writes the start of a definite or indefinite-length array (major type 4).</summary>
903903
<param name="definiteLength">The length of the definite-length array, or <see langword="null" /> for an indefinite-length array.</param>
904-
904+
905905
<remarks>
906906
<format type="text/markdown"><![CDATA[
907907
@@ -1022,22 +1022,22 @@ The written data is not accepted under the current conformance mode.</exception>
10221022
<Docs>
10231023
<summary>Writes the start of a definite or indefinite-length map (major type 5).</summary>
10241024
<param name="definiteLength">The length of the definite-length map, or <see langword="null" /> for an indefinite-length map.</param>
1025-
1025+
10261026
<remarks>
10271027
<format type="text/markdown"><![CDATA[
10281028
10291029
## Remarks
10301030
10311031
In canonical conformance modes, the writer will reject indefinite-length writes unless the <xref:System.Formats.Cbor.CborWriter.ConvertIndefiniteLengthEncodings> flag is enabled.
1032-
1032+
10331033
10341034
Map contents are written as if arrays twice the length of the map's declared size.
10351035
For instance, a map of size `1` containing a key of type int with a value of type string must be written by successive calls to <xref:System.Formats.Cbor.CborWriter.WriteInt32(System.Int32)> and <xref:System.Formats.Cbor.CborWriter.WriteTextString(System.ReadOnlySpan{System.Char})>.
10361036
It is up to the caller to keep track of whether the next call is a key or a value.
1037-
1037+
10381038
10391039
Fundamentally, this is a technical restriction stemming from the fact that CBOR allows keys of any type, for instance a map can contain keys that are maps themselves.
1040-
1040+
10411041
10421042
10431043

0 commit comments

Comments
 (0)