github/Discord.Net
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Fix] Embed ToJsonString & (Try)Parse (#2787)

Browse Source 
* fix

* EmbedBuilderUtils

* lazy

* xmldocs...
This commit is contained in:
Mihail Gribkov
2023-10-05 19:10:01 +03:00
committed by GitHub
parent 0f37677c59
commit 7b5c40aab6
3 changed files with 73 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/Discord.Net.Core/Entities/Messages/EmbedBuilder.cs
View File

@@ -160,55 +160,6 @@ namespace Discord
}
}
/// <summary>
/// Tries to parse a string into an <see cref="EmbedBuilder"/>.
/// </summary>
/// <param name="json">The json string to parse.</param>
/// <param name="builder">The <see cref="EmbedBuilder"/> with populated values. An empty instance if method returns <see langword="false"/>.</param>
/// <returns><see langword="true"/> if <paramref name="json"/> was successfully parsed. <see langword="false"/> if not.</returns>
public static bool TryParse(string json, out EmbedBuilder builder)
{
builder = new EmbedBuilder();
try
{
var model = JsonConvert.DeserializeObject<Embed>(json);
if (model is not null)
{
builder = model.ToEmbedBuilder();
return true;
}
return false;
}
catch
{
return false;
}
}
/// <summary>
/// Parses a string into an <see cref="EmbedBuilder"/>.
/// </summary>
/// <param name="json">The json string to parse.</param>
/// <returns>An <see cref="EmbedBuilder"/> with populated values from the passed <paramref name="json"/>.</returns>
/// <exception cref="InvalidOperationException">Thrown if the string passed is not valid json.</exception>
public static EmbedBuilder Parse(string json)
{
try
{
var model = JsonConvert.DeserializeObject<Embed>(json);
if (model is not null)
return model.ToEmbedBuilder();
return new EmbedBuilder();
}
catch
{
throw;
}
}
/// <summary>
/// Sets the title of an <see cref="Embed"/>.
/// </summary>

5
src/Discord.Net.Rest/Extensions/StringExtensions.cs
View File

@@ -16,7 +16,6 @@ namespace Discord.Rest
{
ContractResolver = new DiscordContractResolver()
};
serializer.Converters.Add(new EmbedTypeConverter());
return serializer;
});
@@ -24,7 +23,7 @@ namespace Discord.Rest
/// Gets a Json formatted <see langword="string"/> from an <see cref="EmbedBuilder"/>.
/// </summary>
/// <remarks>
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// See <see cref="EmbedBuilderUtils.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// </remarks>
/// <param name="builder">The builder to format as Json <see langword="string"/>.</param>
/// <param name="formatting">The formatting in which the Json will be returned.</param>
@@ -36,7 +35,7 @@ namespace Discord.Rest
/// Gets a Json formatted <see langword="string"/> from an <see cref="Embed"/>.
/// </summary>
/// <remarks>
/// See <see cref="EmbedBuilder.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// See <see cref="EmbedBuilderUtils.TryParse(string, out EmbedBuilder)"/> to parse Json back into embed.
/// </remarks>
/// <param name="embed">The embed to format as Json <see langword="string"/>.</param>
/// <param name="formatting">The formatting in which the Json will be returned.</param>

71
src/Discord.Net.Rest/Utils/EmbedBuilderUtils.cs Normal file
View File

@@ -0,0 +1,71 @@
using Discord.Net.Converters;
using Newtonsoft.Json;
using System;
namespace Discord.Rest;
public static class EmbedBuilderUtils
{
private static Lazy<JsonSerializerSettings> _settings = new(() =>
{
var serializer = new JsonSerializerSettings()
{
ContractResolver = new DiscordContractResolver()
};
return serializer;
});
/// <summary>
/// Parses a string into an <see cref="EmbedBuilder"/>.
/// </summary>
/// <param name="json">The json string to parse.</param>
/// <returns>An <see cref="EmbedBuilder"/> with populated values from the passed <paramref name="json"/>.</returns>
/// <exception cref="InvalidOperationException">Thrown if the string passed is not valid json.</exception>
public static EmbedBuilder Parse(string json)
{
try
{
var model = JsonConvert.DeserializeObject<API.Embed>(json, _settings.Value);
var embed = model?.ToEntity();
if (embed is not null)
return embed.ToEmbedBuilder();
return new EmbedBuilder();
}
catch
{
throw;
}
}
/// <summary>
/// Tries to parse a string into an <see cref="EmbedBuilder"/>.
/// </summary>
/// <param name="json">The json string to parse.</param>
/// <param name="builder">The <see cref="EmbedBuilder"/> with populated values. An empty instance if method returns <see langword="false"/>.</param>
/// <returns><see langword="true"/> if <paramref name="json"/> was successfully parsed. <see langword="false"/> if not.</returns>
public static bool TryParse(string json, out EmbedBuilder builder)
{
builder = new EmbedBuilder();
try
{
var model = JsonConvert.DeserializeObject<API.Embed>(json, _settings.Value);
var embed = model?.ToEntity();
if (embed is not null)
{
builder = embed.ToEmbedBuilder();
return true;
}
return false;
}
catch
{
return false;
}
}
}