Skip to content
This repository was archived by the owner on Dec 24, 2022. It is now read-only.

Commit 8c6929d

Browse files
committed
Add code docs
1 parent db2e120 commit 8c6929d

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

src/ServiceStack.Text/HttpUtils.HttpClient.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,6 +1010,9 @@ public static async Task<HttpResponseMessage> PutFileToUrlAsync(this string url,
10101010
public static void AddHeader(this HttpRequestMessage res, string name, string value) =>
10111011
res.WithHeader(name, value);
10121012

1013+
/// <summary>
1014+
/// Returns first Request Header in HttpRequestMessage Headers and Content.Headers
1015+
/// </summary>
10131016
public static string? GetHeader(this HttpRequestMessage req, string name)
10141017
{
10151018
if (RequestHeadersResolver.TryGetValue(name, out var fn))
@@ -1026,6 +1029,10 @@ public static void AddHeader(this HttpRequestMessage res, string name, string va
10261029
};
10271030
public static Dictionary<string, Func<HttpResponseMessage, string?>> ResponseHeadersResolver { get; set; } = new(StringComparer.OrdinalIgnoreCase) {
10281031
};
1032+
1033+
/// <summary>
1034+
/// Returns first Response Header in HttpResponseMessage Headers and Content.Headers
1035+
/// </summary>
10291036
public static string? GetHeader(this HttpResponseMessage res, string name)
10301037
{
10311038
if (ResponseHeadersResolver.TryGetValue(name, out var fn))
@@ -1073,6 +1080,10 @@ public static HttpRequestMessage WithHeader(this HttpRequestMessage httpReq, str
10731080
return httpReq;
10741081
}
10751082

1083+
/// <summary>
1084+
/// Populate HttpRequestMessage with a simpler, untyped API
1085+
/// Syntax compatible with HttpWebRequest
1086+
/// </summary>
10761087
public static HttpRequestMessage With(this HttpRequestMessage httpReq, Action<HttpRequestConfig> configure)
10771088
{
10781089
var config = new HttpRequestConfig();
@@ -1120,6 +1131,9 @@ public static void DownloadFileTo(this string downloadUrl, string fileName,
11201131

11211132
public static class HttpClientExt
11221133
{
1134+
/// <summary>
1135+
/// Case-insensitive, trimmed compare of two content types from start to ';', i.e. without charset suffix
1136+
/// </summary>
11231137
public static bool MatchesContentType(this HttpResponseMessage res, string matchesContentType) =>
11241138
MimeTypes.MatchesContentType(res.GetHeader(HttpHeaders.ContentType), matchesContentType);
11251139

src/ServiceStack.Text/HttpUtils.WebRequest.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1100,6 +1100,10 @@ public static HttpWebRequest WithHeader(this HttpWebRequest httpReq, string name
11001100
return httpReq;
11011101
}
11021102

1103+
/// <summary>
1104+
/// Populate HttpRequestMessage with a simpler, untyped API
1105+
/// Syntax compatible with HttpClient's HttpRequestMessage
1106+
/// </summary>
11031107
public static HttpWebRequest With(this HttpWebRequest httpReq, Action<HttpRequestConfig> configure)
11041108
{
11051109
var config = new HttpRequestConfig();
@@ -1184,9 +1188,16 @@ public void UploadStream(HttpWebRequest webRequest, Stream fileStream, string fi
11841188

11851189
public static class HttpClientExt
11861190
{
1191+
/// <summary>
1192+
/// Case-insensitive, trimmed compare of two content types from start to ';', i.e. without charset suffix
1193+
/// </summary>
11871194
public static bool MatchesContentType(this HttpWebResponse res, string matchesContentType) =>
11881195
MimeTypes.MatchesContentType(res.Headers[HttpHeaders.ContentType], matchesContentType);
1189-
1196+
1197+
/// <summary>
1198+
/// Returns null for unknown Content-length
1199+
/// Syntax + Behavior compatible with HttpClient HttpResponseMessage
1200+
/// </summary>
11901201
public static long? GetContentLength(this HttpWebResponse res) =>
11911202
res.ContentLength == -1 ? null : res.ContentLength;
11921203
}

src/ServiceStack.Text/MimeTypes.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,9 @@ public static string GetRealContentType(string contentType)
9494
: null;
9595
}
9696

97-
//Compares two string from start to ';' char, case-insensitive,
98-
//ignoring (trimming) spaces at start and end
97+
/// <summary>
98+
/// Case-insensitive, trimmed compare of two content types from start to ';', i.e. without charset suffix
99+
/// </summary>
99100
public static bool MatchesContentType(string contentType, string matchesContentType)
100101
{
101102
if (contentType == null || matchesContentType == null)

0 commit comments

Comments
 (0)