Skip to content

Mention Metadata.BinaryHeaderSuffix in xmldoc comments of Metadata.En… #2027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JamesNK merged 3 commits into from
Feb 5, 2023
Merged

Mention Metadata.BinaryHeaderSuffix in xmldoc comments of Metadata.En… #2027

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fde7f2d
Mention Metadata.BinaryHeaderSuffix constant in xmldoc comments of Me…
voroninp Jan 26, 2023
c625dd3
Update Metadata.cs
JamesNK Feb 4, 2023
a29189b
Apply suggestions from code review
JamesNK Feb 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions src/Grpc.Core.Api/Metadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,20 @@ public IEnumerable<Entry> GetAll(string key)
}

/// <summary>
/// Adds a new ASCII-valued metadata entry. See <c>Metadata.Entry</c> constructor for params.
/// Adds a new ASCII-valued metadata entry.
/// </summary>
/// <param name="key">Metadata key. Gets converted to lowercase. Must not use <c>-bin</c> suffix indicating a binary-valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens, and dots.</param>
/// <param name="value">Value string. Only ASCII characters are allowed.</param>
public void Add(string key, string value)
{
Add(new Entry(key, value));
}

/// <summary>
/// Adds a new binary-valued metadata entry. See <c>Metadata.Entry</c> constructor for params.
/// Adds a new binary-valued metadata entry.
/// </summary>
/// <param name="key">Metadata key. Gets converted to lowercase. Needs to have <c>-bin</c> suffix indicating a binary-valued metadata entry. The binary header suffix can be added to the key with <see cref="Metadata.BinaryHeaderSuffix"/>. Can only contain lowercase alphanumeric characters, underscores, hyphens, and dots.</param>
/// <param name="valueBytes">Value bytes.</param>
public void Add(string key, byte[] valueBytes)
{
Add(new Entry(key, valueBytes));
Expand Down Expand Up @@ -290,13 +294,13 @@ private Entry(string key, string? value, byte[]? valueBytes)
/// <summary>
/// Initializes a new instance of the <see cref="Grpc.Core.Metadata.Entry"/> struct with a binary value.
/// </summary>
/// <param name="key">Metadata key. Gets converted to lowercase. Needs to have suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</param>
/// <param name="key">Metadata key. Gets converted to lowercase. Needs to have <c>-bin</c> suffix indicating a binary-valued metadata entry. The binary header suffix can be added to the key with <see cref="Metadata.BinaryHeaderSuffix"/>. Can only contain lowercase alphanumeric characters, underscores, hyphens, and dots.</param>
/// <param name="valueBytes">Value bytes.</param>
public Entry(string key, byte[] valueBytes)
{
this.key = NormalizeKey(key);
GrpcPreconditions.CheckArgument(HasBinaryHeaderSuffix(this.key),
"Key for binary valued metadata entry needs to have suffix indicating binary value.");
$"Key for binary valued metadata entry needs to have '{BinaryHeaderSuffix}' suffix indicating binary value.");
this.value = null;
GrpcPreconditions.CheckNotNull(valueBytes, "valueBytes");
this.valueBytes = new byte[valueBytes.Length];
Expand All @@ -306,7 +310,7 @@ public Entry(string key, byte[] valueBytes)
/// <summary>
/// Initializes a new instance of the <see cref="Grpc.Core.Metadata.Entry"/> struct with an ASCII value.
/// </summary>
/// <param name="key">Metadata key. Gets converted to lowercase. Must not use suffix indicating a binary valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens and dots.</param>
/// <param name="key">Metadata key. Gets converted to lowercase. Must not use '-bin' suffix indicating a binary-valued metadata entry. Can only contain lowercase alphanumeric characters, underscores, hyphens, and dots.</param>
/// <param name="value">Value string. Only ASCII characters are allowed.</param>
public Entry(string key, string value)
{
Expand Down